diff options
Diffstat (limited to 'docs/cli_commands.md')
| -rw-r--r-- | docs/cli_commands.md | 50 |
1 files changed, 36 insertions, 14 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md index 4e27622c7..8fa7ad41d 100644 --- a/docs/cli_commands.md +++ b/docs/cli_commands.md | |||
| @@ -17,7 +17,7 @@ qmk compile [-c] <configuratorExport.json> | |||
| 17 | **Usage for Keymaps**: | 17 | **Usage for Keymaps**: |
| 18 | 18 | ||
| 19 | ``` | 19 | ``` |
| 20 | qmk compile [-c] [-e <var>=<value>] -kb <keyboard_name> -km <keymap_name> | 20 | qmk compile [-c] [-e <var>=<value>] [-j <num_jobs>] -kb <keyboard_name> -km <keymap_name> |
| 21 | ``` | 21 | ``` |
| 22 | 22 | ||
| 23 | **Usage in Keyboard Directory**: | 23 | **Usage in Keyboard Directory**: |
| @@ -73,6 +73,17 @@ $ qmk compile -kb dz60 | |||
| 73 | ... | 73 | ... |
| 74 | ``` | 74 | ``` |
| 75 | 75 | ||
| 76 | **Parallel Compilation**: | ||
| 77 | |||
| 78 | It is possible to speed up compilation by adding the `-j`/`--parallel` flag. | ||
| 79 | ``` | ||
| 80 | qmk compile -j <num_jobs> -kb <keyboard_name> | ||
| 81 | ``` | ||
| 82 | The `num_jobs` argument determines the maximum number of jobs that can be used. Setting it to zero will enable parallel compilation without limiting the maximum number of jobs. | ||
| 83 | ``` | ||
| 84 | qmk compile -j 0 -kb <keyboard_name> | ||
| 85 | ``` | ||
| 86 | |||
| 76 | ## `qmk flash` | 87 | ## `qmk flash` |
| 77 | 88 | ||
| 78 | This command is similar to `qmk compile`, but can also target a bootloader. The bootloader is optional, and is set to `:flash` by default. To specify a different bootloader, use `-bl <bootloader>`. Visit the [Flashing Firmware](flashing.md) guide for more details of the available bootloaders. | 89 | This command is similar to `qmk compile`, but can also target a bootloader. The bootloader is optional, and is set to `:flash` by default. To specify a different bootloader, use `-bl <bootloader>`. Visit the [Flashing Firmware](flashing.md) guide for more details of the available bootloaders. |
| @@ -82,13 +93,13 @@ This command is directory aware. It will automatically fill in KEYBOARD and/or K | |||
| 82 | **Usage for Configurator Exports**: | 93 | **Usage for Configurator Exports**: |
| 83 | 94 | ||
| 84 | ``` | 95 | ``` |
| 85 | qmk flash [-bl <bootloader>] [-c] [-e <var>=<value>] <configuratorExport.json> | 96 | qmk flash [-bl <bootloader>] [-c] [-e <var>=<value>] [-j <num_jobs>] <configuratorExport.json> |
| 86 | ``` | 97 | ``` |
| 87 | 98 | ||
| 88 | **Usage for Keymaps**: | 99 | **Usage for Keymaps**: |
| 89 | 100 | ||
| 90 | ``` | 101 | ``` |
| 91 | qmk flash -kb <keyboard_name> -km <keymap_name> [-bl <bootloader>] [-c] [-e <var>=<value>] | 102 | qmk flash -kb <keyboard_name> -km <keymap_name> [-bl <bootloader>] [-c] [-e <var>=<value>] [-j <num_jobs>] |
| 92 | ``` | 103 | ``` |
| 93 | 104 | ||
| 94 | **Listing the Bootloaders** | 105 | **Listing the Bootloaders** |
| @@ -109,7 +120,7 @@ qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN] | |||
| 109 | 120 | ||
| 110 | ## `qmk console` | 121 | ## `qmk console` |
| 111 | 122 | ||
| 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`. | 123 | 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 | 124 | ||
| 114 | **Usage**: | 125 | **Usage**: |
| 115 | 126 | ||
| @@ -280,12 +291,12 @@ qmk list-keymaps -kb planck/ez | |||
| 280 | 291 | ||
| 281 | This command creates a new keyboard based on available templates. | 292 | This command creates a new keyboard based on available templates. |
| 282 | 293 | ||
| 283 | This command will prompt for input to guide you though the generation process. | 294 | 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 | 295 | ||
| 285 | **Usage**: | 296 | **Usage**: |
| 286 | 297 | ||
| 287 | ``` | 298 | ``` |
| 288 | qmk new-keyboard | 299 | qmk new-keyboard [-kb KEYBOARD] [-t {avr,ps2avrgb}] -u USERNAME |
| 289 | ``` | 300 | ``` |
| 290 | 301 | ||
| 291 | ## `qmk new-keymap` | 302 | ## `qmk new-keymap` |
| @@ -314,7 +325,18 @@ qmk clean [-a] | |||
| 314 | 325 | ||
| 315 | # Developer Commands | 326 | # Developer Commands |
| 316 | 327 | ||
| 317 | ## `qmk cformat` | 328 | ## `qmk format-text` |
| 329 | |||
| 330 | This command formats text files to have proper line endings. | ||
| 331 | |||
| 332 | Every text file in the repository needs to have Unix (LF) line ending. | ||
| 333 | If you are working on **Windows**, you must ensure that line endings are corrected in order to get your PRs merged. | ||
| 334 | |||
| 335 | ``` | ||
| 336 | qmk format-text | ||
| 337 | ``` | ||
| 338 | |||
| 339 | ## `qmk format-c` | ||
| 318 | 340 | ||
| 319 | This command formats C code using clang-format. | 341 | This command formats C code using clang-format. |
| 320 | 342 | ||
| @@ -325,25 +347,25 @@ Run it with `-a` to format all core code, or pass filenames on the command line | |||
| 325 | **Usage for specified files**: | 347 | **Usage for specified files**: |
| 326 | 348 | ||
| 327 | ``` | 349 | ``` |
| 328 | qmk cformat [file1] [file2] [...] [fileN] | 350 | qmk format-c [file1] [file2] [...] [fileN] |
| 329 | ``` | 351 | ``` |
| 330 | 352 | ||
| 331 | **Usage for all core files**: | 353 | **Usage for all core files**: |
| 332 | 354 | ||
| 333 | ``` | 355 | ``` |
| 334 | qmk cformat -a | 356 | qmk format-c -a |
| 335 | ``` | 357 | ``` |
| 336 | 358 | ||
| 337 | **Usage for only changed files against origin/master**: | 359 | **Usage for only changed files against origin/master**: |
| 338 | 360 | ||
| 339 | ``` | 361 | ``` |
| 340 | qmk cformat | 362 | qmk format-c |
| 341 | ``` | 363 | ``` |
| 342 | 364 | ||
| 343 | **Usage for only changed files against branch_name**: | 365 | **Usage for only changed files against branch_name**: |
| 344 | 366 | ||
| 345 | ``` | 367 | ``` |
| 346 | qmk cformat -b branch_name | 368 | qmk format-c -b branch_name |
| 347 | ``` | 369 | ``` |
| 348 | 370 | ||
| 349 | ## `qmk docs` | 371 | ## `qmk docs` |
| @@ -369,7 +391,7 @@ qmk generate-docs | |||
| 369 | 391 | ||
| 370 | ## `qmk generate-rgb-breathe-table` | 392 | ## `qmk generate-rgb-breathe-table` |
| 371 | 393 | ||
| 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/`. | 394 | 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 | 395 | ||
| 374 | **Usage**: | 396 | **Usage**: |
| 375 | 397 | ||
| @@ -399,14 +421,14 @@ $ qmk kle2json -f kle.txt -f | |||
| 399 | Ψ Wrote out to info.json | 421 | Ψ Wrote out to info.json |
| 400 | ``` | 422 | ``` |
| 401 | 423 | ||
| 402 | ## `qmk pyformat` | 424 | ## `qmk format-python` |
| 403 | 425 | ||
| 404 | This command formats python code in `qmk_firmware`. | 426 | This command formats python code in `qmk_firmware`. |
| 405 | 427 | ||
| 406 | **Usage**: | 428 | **Usage**: |
| 407 | 429 | ||
| 408 | ``` | 430 | ``` |
| 409 | qmk pyformat | 431 | qmk format-python |
| 410 | ``` | 432 | ``` |
| 411 | 433 | ||
| 412 | ## `qmk pytest` | 434 | ## `qmk pytest` |
