aboutsummaryrefslogtreecommitdiffstats
path: root/docs/cli.md
diff options
context:
space:
mode:
authorGravatar St. John Johnson <st.john.johnson@gmail.com>2019-10-28 18:24:36 -0700
committerGravatar Joel Challis <git@zvecr.com>2019-10-29 01:24:36 +0000
commite0e26957d43018998c405783a2609b99f0e098a7 (patch)
treec6af0420e437ddce75fdee011962c4a071152d0c /docs/cli.md
parentafc5cb7f0abafd75c178b188a5fc1b9138fba956 (diff)
downloadqmk_firmware-e0e26957d43018998c405783a2609b99f0e098a7.tar.gz
Fix the CLI docs (#6979)
- Sort the commands alphabetically - Add missing `json_keymap` - Correct underscore to dash
Diffstat (limited to 'docs/cli.md')
-rw-r--r--docs/cli.md30
1 files changed, 20 insertions, 10 deletions
diff --git a/docs/cli.md b/docs/cli.md
index 0d3703c8c..e655b0ee8 100644
--- a/docs/cli.md
+++ b/docs/cli.md
@@ -69,6 +69,16 @@ There are some limitations to the local CLI compared to the global CLI:
# CLI Commands
+## `qmk cformat`
+
+This command formats C code using clang-format. Run it with no arguments to format all core code, or pass filenames on the command line to run it on specific files.
+
+**Usage**:
+
+```
+qmk cformat [file1] [file2] [...] [fileN]
+```
+
## `qmk compile`
This command allows you to compile firmware from any directory. You can compile JSON exports from <https://config.qmk.fm> or compile keymaps in the repo.
@@ -85,16 +95,6 @@ qmk compile <configuratorExport.json>
qmk compile -kb <keyboard_name> -km <keymap_name>
```
-## `qmk cformat`
-
-This command formats C code using clang-format. Run it with no arguments to format all core code, or pass filenames on the command line to run it on specific files.
-
-**Usage**:
-
-```
-qmk cformat [file1] [file2] [...] [fileN]
-```
-
## `qmk config`
This command lets you configure the behavior of QMK. For the full `qmk config` documentation see [CLI Configuration](cli_configuration.md).
@@ -125,6 +125,16 @@ This command examines your environment and alerts you to potential build or flas
qmk doctor
```
+## `qmk json-keymap`
+
+Creates a keymap.c from a QMK Configurator export.
+
+**Usage**:
+
+```
+qmk json-keymap [-o OUTPUT] filename
+```
+
## `qmk list-keyboards`
This command lists all the keyboards currently defined in `qmk_firmware`