aboutsummaryrefslogtreecommitdiff
path: root/docs/cli_commands.md
diff options
context:
space:
mode:
authorAlexandr <[email protected]>2024-05-07 14:51:46 +0300
committerGitHub <[email protected]>2024-05-07 12:51:46 +0100
commit16557f9975abf693675e2cc246f3d1b1f73faf96 (patch)
tree66ab0acc3d7612fb5ff9e2e1a23cba28042744f0 /docs/cli_commands.md
parent69640365f81c23d189a1d2266b772b536049aa25 (diff)
downloadqmk_firmware-16557f9975abf693675e2cc246f3d1b1f73faf96.tar.gz
qmk_firmware-16557f9975abf693675e2cc246f3d1b1f73faf96.zip
add example for c2json command (#23061)
Diffstat (limited to 'docs/cli_commands.md')
-rw-r--r--docs/cli_commands.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md
index cf174949af..685fad43b7 100644
--- a/docs/cli_commands.md
+++ b/docs/cli_commands.md
@@ -322,6 +322,18 @@ Creates a keymap.json from a keymap.c.
qmk c2json -km KEYMAP -kb KEYBOARD [-q] [--no-cpp] [-o OUTPUT] filename
```
+**Examples**:
+
+```
+qmk c2json -km default -kb handwired/dactyl_promicro
+```
+
+or with filename:
+
+```
+qmk c2json keyboards/handwired/dactyl_promicro/keymaps/default/keymap.c
+```
+
## `qmk lint`
Checks over a keyboard and/or keymap and highlights common errors, problems, and anti-patterns.