aboutsummaryrefslogtreecommitdiff
path: root/docs/cli_commands.md
diff options
context:
space:
mode:
authorErovia <erovia@users.noreply.github.com>2020-03-22 19:48:30 +0100
committerskullydazed <skullydazed@users.noreply.github.com>2020-04-08 09:31:14 -0700
commit5cfc3ce02e3c8007ac42e8089ecc895771bb3bfb (patch)
treecd57c376585c927e353190a785810b68ad9f9594 /docs/cli_commands.md
parent724f20ed32758b0c5d91ad4b7ba4a9348e152eeb (diff)
downloadqmk_firmware-5cfc3ce02e3c8007ac42e8089ecc895771bb3bfb.tar.gz
qmk_firmware-5cfc3ce02e3c8007ac42e8089ecc895771bb3bfb.zip
Rebase on master, hide some other subcommands
The list of hidden subcommands were approved by @skullydazed ;) Currently hidden if 'user.developer' is not True: - cformat - docs - kle2json - pyformat - pytest
Diffstat (limited to 'docs/cli_commands.md')
-rw-r--r--docs/cli_commands.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md
index eb5362bd2..570f841bc 100644
--- a/docs/cli_commands.md
+++ b/docs/cli_commands.md
@@ -4,6 +4,8 @@
4 4
5## `qmk cformat` 5## `qmk cformat`
6 6
7*(dev mode)*
8
7This command formats C code using clang-format. 9This command formats C code using clang-format.
8 10
9Run it with no arguments to format all core code that has been changed. Default checks `origin/master` with `git diff`, branch can be changed using `-b <branch_name>` 11Run it with no arguments to format all core code that has been changed. Default checks `origin/master` with `git diff`, branch can be changed using `-b <branch_name>`
@@ -138,6 +140,8 @@ qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN]
138 140
139## `qmk docs` 141## `qmk docs`
140 142
143*(dev mode)*
144
141This command starts a local HTTP server which you can use for browsing or improving the docs. Default port is 8936. 145This command starts a local HTTP server which you can use for browsing or improving the docs. Default port is 8936.
142 146
143**Usage**: 147**Usage**:
@@ -182,6 +186,8 @@ qmk json2c [-o OUTPUT] filename
182 186
183## `qmk kle2json` 187## `qmk kle2json`
184 188
189*(dev mode)*
190
185This command allows you to convert from raw KLE data to QMK Configurator JSON. It accepts either an absolute file path, or a file name in the current directory. By default it will not overwrite `info.json` if it is already present. Use the `-f` or `--force` flag to overwrite. 191This command allows you to convert from raw KLE data to QMK Configurator JSON. It accepts either an absolute file path, or a file name in the current directory. By default it will not overwrite `info.json` if it is already present. Use the `-f` or `--force` flag to overwrite.
186 192
187**Usage**: 193**Usage**:
@@ -234,6 +240,8 @@ qmk new-keymap [-kb KEYBOARD] [-km KEYMAP]
234 240
235## `qmk pyformat` 241## `qmk pyformat`
236 242
243*(dev mode)*
244
237This command formats python code in `qmk_firmware`. 245This command formats python code in `qmk_firmware`.
238 246
239**Usage**: 247**Usage**:
@@ -244,6 +252,8 @@ qmk pyformat
244 252
245## `qmk pytest` 253## `qmk pytest`
246 254
255*(dev mode)*
256
247This command runs the python test suite. If you make changes to python code you should ensure this runs successfully. 257This command runs the python test suite. If you make changes to python code you should ensure this runs successfully.
248 258
249**Usage**: 259**Usage**: