summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorQMK Bot <hello@qmk.fm>2022-03-24 20:14:36 +0000
committerQMK Bot <hello@qmk.fm>2022-03-24 20:14:36 +0000
commit2957f60dc10d479d94508263d5741917051ed28d (patch)
treec3ae126c92e78d6f86097c9d44d6ea2d402124af /docs
parentdc9eb21332b0fc274cc69358032dc923da6dc306 (diff)
parentefc9c525b19b33c6e09057218ea64f07f45f9555 (diff)
downloadqmk_firmware-2957f60dc10d479d94508263d5741917051ed28d.tar.gz
qmk_firmware-2957f60dc10d479d94508263d5741917051ed28d.zip
Merge remote-tracking branch 'origin/master' into develop
Diffstat (limited to 'docs')
-rw-r--r--docs/cli_commands.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md
index 93af906b8a..463abcef12 100644
--- a/docs/cli_commands.md
+++ b/docs/cli_commands.md
@@ -335,6 +335,23 @@ This command cleans up the `.build` folder. If `--all` is passed, any .hex or .b
qmk clean [-a]
```
+## `qmk via2json`
+
+This command an generate a keymap.json from a VIA keymap backup. Both the layers and the macros are converted, enabling users to easily move away from a VIA-enabled firmware without writing any code or reimplementing their keymaps in QMK Configurator.
+
+**Usage**:
+
+```
+qmk via2json -kb KEYBOARD [-l LAYOUT] [-km KEYMAP] [-o OUTPUT] filename
+```
+
+**Example:**
+
+```
+$ qmk via2json -kb ai03/polaris -o polaris_keymap.json polaris_via_backup.json
+Ψ Wrote keymap to /home/you/qmk_firmware/polaris_keymap.json
+```
+
---
# Developer Commands