From efc9c525b19b33c6e09057218ea64f07f45f9555 Mon Sep 17 00:00:00 2001
From: Erovia <Erovia@users.noreply.github.com>
Date: Thu, 24 Mar 2022 20:13:40 +0000
Subject: CLI: Add 'via2json' subcommand (#16468)

---
 docs/cli_commands.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

(limited to 'docs')

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
-- 
cgit v1.2.1