diff options
| author | Erovia <Erovia@users.noreply.github.com> | 2022-03-24 20:13:40 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-03-24 21:13:40 +0100 |
| commit | efc9c525b19b33c6e09057218ea64f07f45f9555 (patch) | |
| tree | 765e189c47e7e3a7bf8d18bbfbc45913546d07c4 /docs | |
| parent | f7a5ec2483ef05d22b6604f0da1447cea5281243 (diff) | |
CLI: Add 'via2json' subcommand (#16468)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/cli_commands.md | 17 |
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 |