summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorDan McClain <dan@danmcclain.net>2019-10-07 14:32:30 -0400
committernoroadsleft <18669334+noroadsleft@users.noreply.github.com>2019-10-07 11:32:30 -0700
commitf04e58dad6f56cdbd5d369c9e00405dcdb47c8ea (patch)
tree3731766a019c84f9a080cade3f4eee4460473341 /docs
parentd9b056486bf62f4751999d926fb3f8aad6d0c821 (diff)
[CLI] Add `qmk list_keyboards` (#6927)
`list_keyboards` replicates the `make list-keyboards` by globbing for all paths that include `rules.mk` and then removing the paths that include `keymaps`. This basis of this cli command could be reused in the future as a util, but is not done so here since this would be the only place that would use it currently Resolves #6911
Diffstat (limited to 'docs')
-rw-r--r--docs/cli.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/cli.md b/docs/cli.md
index fe86cac1fb..6ffe033653 100644
--- a/docs/cli.md
+++ b/docs/cli.md
@@ -115,6 +115,16 @@ This command examines your environment and alerts you to potential build or flas
qmk doctor
```
+## `qmk list_keyboards`
+
+This command lists all the keyboards currently defined in `qmk_firmware`
+
+**Usage**:
+
+```
+qmk list_keyboards
+```
+
## `qmk new-keymap`
This command creates a new keymap based on a keyboard's existing default keymap.