diff options
| author | St. John Johnson <st.john.johnson@gmail.com> | 2019-10-28 18:24:36 -0700 |
|---|---|---|
| committer | Joel Challis <git@zvecr.com> | 2019-10-29 01:24:36 +0000 |
| commit | e0e26957d43018998c405783a2609b99f0e098a7 (patch) | |
| tree | c6af0420e437ddce75fdee011962c4a071152d0c /docs | |
| parent | afc5cb7f0abafd75c178b188a5fc1b9138fba956 (diff) | |
| download | qmk_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')
| -rw-r--r-- | docs/cli.md | 30 |
1 files changed, 20 insertions, 10 deletions
diff --git a/docs/cli.md b/docs/cli.md index 0d3703c8cf..e655b0ee89 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` |