aboutsummaryrefslogtreecommitdiffstats
path: root/docs/cli.md
diff options
context:
space:
mode:
authorGravatar Erovia <erovia@users.noreply.github.com>2019-10-13 19:07:22 +0200
committerGravatar skullydazed <skullydazed@users.noreply.github.com>2020-02-15 15:19:03 -0800
commit26f53d38d932a21be9edfc3d55e585c21050c3a2 (patch)
treef4d19abe22da554fe9a40928f6fc3eca6163e2ab /docs/cli.md
parentf96085af3877a8c42d0767d13d47c239ce08ef0f (diff)
downloadqmk_firmware-26f53d38d932a21be9edfc3d55e585c21050c3a2.tar.gz
Another major refactoring, add documentation
Move all useful functions to the qmk module and use the cli subcommand as a wrapper around it. Add both inline comments and documentation.
Diffstat (limited to 'docs/cli.md')
-rw-r--r--docs/cli.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/cli.md b/docs/cli.md
index f1c158af4..f2b433fbb 100644
--- a/docs/cli.md
+++ b/docs/cli.md
@@ -252,6 +252,16 @@ This command lists all the keyboards currently defined in `qmk_firmware`
qmk list-keyboards
```
+## `qmk list_keymaps`
+
+This command lists all the keymaps for a specified keyboard (and revision).
+
+**Usage**:
+
+```
+qmk list_keymaps -kb planck/ez
+```
+
## `qmk new-keymap`
This command creates a new keymap based on a keyboard's existing default keymap.