diff options
Diffstat (limited to 'docs/cli_commands.md')
| -rw-r--r-- | docs/cli_commands.md | 19 |
1 files changed, 18 insertions, 1 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md index c970b1efa..b10f5d499 100644 --- a/docs/cli_commands.md +++ b/docs/cli_commands.md | |||
| @@ -178,6 +178,24 @@ Creates a keymap.json from a keymap.c. | |||
| 178 | qmk c2json [--no-cpp] [-o OUTPUT] filename | 178 | qmk c2json [--no-cpp] [-o OUTPUT] filename |
| 179 | ``` | 179 | ``` |
| 180 | 180 | ||
| 181 | ## `qmk lint` | ||
| 182 | |||
| 183 | Checks over a keyboard and/or keymap and highlights common errors, problems, and anti-patterns. | ||
| 184 | |||
| 185 | **Usage**: | ||
| 186 | |||
| 187 | ``` | ||
| 188 | qmk lint [-km KEYMAP] [-kb KEYBOARD] [--strict] | ||
| 189 | ``` | ||
| 190 | |||
| 191 | This command is directory aware. It will automatically fill in KEYBOARD and/or KEYMAP if you are in a keyboard or keymap directory. | ||
| 192 | |||
| 193 | **Examples**: | ||
| 194 | |||
| 195 | Do a basic lint check: | ||
| 196 | |||
| 197 | qmk lint -kb rominronin/katana60/rev2 | ||
| 198 | |||
| 181 | ## `qmk list-keyboards` | 199 | ## `qmk list-keyboards` |
| 182 | 200 | ||
| 183 | This command lists all the keyboards currently defined in `qmk_firmware` | 201 | This command lists all the keyboards currently defined in `qmk_firmware` |
| @@ -309,4 +327,3 @@ This command runs the python test suite. If you make changes to python code you | |||
| 309 | ``` | 327 | ``` |
| 310 | qmk pytest | 328 | qmk pytest |
| 311 | ``` | 329 | ``` |
| 312 | |||
