diff options
Diffstat (limited to 'docs/cli_commands.md')
| -rw-r--r-- | docs/cli_commands.md | 33 |
1 files changed, 22 insertions, 11 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md index 4e27622c7..c7468eb5e 100644 --- a/docs/cli_commands.md +++ b/docs/cli_commands.md | |||
| @@ -109,7 +109,7 @@ qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN] | |||
| 109 | 109 | ||
| 110 | ## `qmk console` | 110 | ## `qmk console` |
| 111 | 111 | ||
| 112 | This command lets you connect to keyboard consoles to get debugging messages. It only works if your keyboard firmware has been compiled with `CONSOLE_ENABLED=yes`. | 112 | This command lets you connect to keyboard consoles to get debugging messages. It only works if your keyboard firmware has been compiled with `CONSOLE_ENABLE=yes`. |
| 113 | 113 | ||
| 114 | **Usage**: | 114 | **Usage**: |
| 115 | 115 | ||
| @@ -280,12 +280,12 @@ qmk list-keymaps -kb planck/ez | |||
| 280 | 280 | ||
| 281 | This command creates a new keyboard based on available templates. | 281 | This command creates a new keyboard based on available templates. |
| 282 | 282 | ||
| 283 | This command will prompt for input to guide you though the generation process. | 283 | Any arguments that are not provided will prompt for input. If `-u` is not passed and `user.name` is set in .gitconfig, it will be used as the default username in the prompt. |
| 284 | 284 | ||
| 285 | **Usage**: | 285 | **Usage**: |
| 286 | 286 | ||
| 287 | ``` | 287 | ``` |
| 288 | qmk new-keyboard | 288 | qmk new-keyboard [-kb KEYBOARD] [-t {avr,ps2avrgb}] -u USERNAME |
| 289 | ``` | 289 | ``` |
| 290 | 290 | ||
| 291 | ## `qmk new-keymap` | 291 | ## `qmk new-keymap` |
| @@ -314,7 +314,18 @@ qmk clean [-a] | |||
| 314 | 314 | ||
| 315 | # Developer Commands | 315 | # Developer Commands |
| 316 | 316 | ||
| 317 | ## `qmk cformat` | 317 | ## `qmk format-text` |
| 318 | |||
| 319 | This command formats text files to have proper line endings. | ||
| 320 | |||
| 321 | Every text file in the repository needs to have Unix (LF) line ending. | ||
| 322 | If you are working on **Windows**, you must ensure that line endings are corrected in order to get your PRs merged. | ||
| 323 | |||
| 324 | ``` | ||
| 325 | qmk format-text | ||
| 326 | ``` | ||
| 327 | |||
| 328 | ## `qmk format-c` | ||
| 318 | 329 | ||
| 319 | This command formats C code using clang-format. | 330 | This command formats C code using clang-format. |
| 320 | 331 | ||
| @@ -325,25 +336,25 @@ Run it with `-a` to format all core code, or pass filenames on the command line | |||
| 325 | **Usage for specified files**: | 336 | **Usage for specified files**: |
| 326 | 337 | ||
| 327 | ``` | 338 | ``` |
| 328 | qmk cformat [file1] [file2] [...] [fileN] | 339 | qmk format-c [file1] [file2] [...] [fileN] |
| 329 | ``` | 340 | ``` |
| 330 | 341 | ||
| 331 | **Usage for all core files**: | 342 | **Usage for all core files**: |
| 332 | 343 | ||
| 333 | ``` | 344 | ``` |
| 334 | qmk cformat -a | 345 | qmk format-c -a |
| 335 | ``` | 346 | ``` |
| 336 | 347 | ||
| 337 | **Usage for only changed files against origin/master**: | 348 | **Usage for only changed files against origin/master**: |
| 338 | 349 | ||
| 339 | ``` | 350 | ``` |
| 340 | qmk cformat | 351 | qmk format-c |
| 341 | ``` | 352 | ``` |
| 342 | 353 | ||
| 343 | **Usage for only changed files against branch_name**: | 354 | **Usage for only changed files against branch_name**: |
| 344 | 355 | ||
| 345 | ``` | 356 | ``` |
| 346 | qmk cformat -b branch_name | 357 | qmk format-c -b branch_name |
| 347 | ``` | 358 | ``` |
| 348 | 359 | ||
| 349 | ## `qmk docs` | 360 | ## `qmk docs` |
| @@ -369,7 +380,7 @@ qmk generate-docs | |||
| 369 | 380 | ||
| 370 | ## `qmk generate-rgb-breathe-table` | 381 | ## `qmk generate-rgb-breathe-table` |
| 371 | 382 | ||
| 372 | This command generates a lookup table (LUT) header file for the [RGB Lighting](feature_rgblight.md) feature's breathing animation. Place this file in your keyboard or keymap directory as `rgblight_breathe_table.h` to override the default LUT in `quantum/`. | 383 | This command generates a lookup table (LUT) header file for the [RGB Lighting](feature_rgblight.md) feature's breathing animation. Place this file in your keyboard or keymap directory as `rgblight_breathe_table.h` to override the default LUT in `quantum/rgblight/`. |
| 373 | 384 | ||
| 374 | **Usage**: | 385 | **Usage**: |
| 375 | 386 | ||
| @@ -399,14 +410,14 @@ $ qmk kle2json -f kle.txt -f | |||
| 399 | Ψ Wrote out to info.json | 410 | Ψ Wrote out to info.json |
| 400 | ``` | 411 | ``` |
| 401 | 412 | ||
| 402 | ## `qmk pyformat` | 413 | ## `qmk format-python` |
| 403 | 414 | ||
| 404 | This command formats python code in `qmk_firmware`. | 415 | This command formats python code in `qmk_firmware`. |
| 405 | 416 | ||
| 406 | **Usage**: | 417 | **Usage**: |
| 407 | 418 | ||
| 408 | ``` | 419 | ``` |
| 409 | qmk pyformat | 420 | qmk format-python |
| 410 | ``` | 421 | ``` |
| 411 | 422 | ||
| 412 | ## `qmk pytest` | 423 | ## `qmk pytest` |
