diff options
author | Erovia <[email protected]> | 2020-03-22 19:48:30 +0100 |
---|---|---|
committer | skullydazed <[email protected]> | 2020-04-08 09:31:14 -0700 |
commit | 5cfc3ce02e3c8007ac42e8089ecc895771bb3bfb (patch) | |
tree | cd57c376585c927e353190a785810b68ad9f9594 /docs/cli_commands.md | |
parent | 724f20ed32758b0c5d91ad4b7ba4a9348e152eeb (diff) | |
download | qmk_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.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md index eb5362bd29..570f841bc8 100644 --- a/docs/cli_commands.md +++ b/docs/cli_commands.md @@ -4,6 +4,8 @@ ## `qmk cformat` +*(dev mode)* + This command formats C code using clang-format. Run 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] ## `qmk docs` +*(dev mode)* + This command starts a local HTTP server which you can use for browsing or improving the docs. Default port is 8936. **Usage**: @@ -182,6 +186,8 @@ qmk json2c [-o OUTPUT] filename ## `qmk kle2json` +*(dev mode)* + This 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. **Usage**: @@ -234,6 +240,8 @@ qmk new-keymap [-kb KEYBOARD] [-km KEYMAP] ## `qmk pyformat` +*(dev mode)* + This command formats python code in `qmk_firmware`. **Usage**: @@ -244,6 +252,8 @@ qmk pyformat ## `qmk pytest` +*(dev mode)* + This command runs the python test suite. If you make changes to python code you should ensure this runs successfully. **Usage**: |