aboutsummaryrefslogtreecommitdiff
path: root/docs/cli.md
diff options
context:
space:
mode:
authorSt. John Johnson <st.john.johnson@gmail.com>2019-10-28 18:24:36 -0700
committerJoel Challis <git@zvecr.com>2019-10-29 01:24:36 +0000
commite0e26957d43018998c405783a2609b99f0e098a7 (patch)
treec6af0420e437ddce75fdee011962c4a071152d0c /docs/cli.md
parentafc5cb7f0abafd75c178b188a5fc1b9138fba956 (diff)
downloadqmk_firmware-e0e26957d43018998c405783a2609b99f0e098a7.tar.gz
qmk_firmware-e0e26957d43018998c405783a2609b99f0e098a7.zip
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:
69 69
70# CLI Commands 70# CLI Commands
71 71
72## `qmk cformat`
73
74This 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.
75
76**Usage**:
77
78```
79qmk cformat [file1] [file2] [...] [fileN]
80```
81
72## `qmk compile` 82## `qmk compile`
73 83
74This 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. 84This 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>
85qmk compile -kb <keyboard_name> -km <keymap_name> 95qmk compile -kb <keyboard_name> -km <keymap_name>
86``` 96```
87 97
88## `qmk cformat`
89
90This 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.
91
92**Usage**:
93
94```
95qmk cformat [file1] [file2] [...] [fileN]
96```
97
98## `qmk config` 98## `qmk config`
99 99
100This command lets you configure the behavior of QMK. For the full `qmk config` documentation see [CLI Configuration](cli_configuration.md). 100This 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
125qmk doctor 125qmk doctor
126``` 126```
127 127
128## `qmk json-keymap`
129
130Creates a keymap.c from a QMK Configurator export.
131
132**Usage**:
133
134```
135qmk json-keymap [-o OUTPUT] filename
136```
137
128## `qmk list-keyboards` 138## `qmk list-keyboards`
129 139
130This command lists all the keyboards currently defined in `qmk_firmware` 140This command lists all the keyboards currently defined in `qmk_firmware`