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 4e27622c74..8fa7ad41dc 100644 --- a/docs/cli_commands.md +++ b/docs/cli_commands.md @@ -17,7 +17,7 @@ qmk compile [-c] <configuratorExport.json>  **Usage for Keymaps**:  ``` -qmk compile [-c] [-e <var>=<value>] -kb <keyboard_name> -km <keymap_name> +qmk compile [-c] [-e <var>=<value>] [-j <num_jobs>] -kb <keyboard_name> -km <keymap_name>  ```  **Usage in Keyboard Directory**:   @@ -73,6 +73,17 @@ $ qmk compile -kb dz60  ...  ``` +**Parallel Compilation**: + +It is possible to speed up compilation by adding the `-j`/`--parallel` flag. +``` +qmk compile -j <num_jobs> -kb <keyboard_name> +``` +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. +``` +qmk compile -j 0 -kb <keyboard_name> +``` +  ## `qmk flash`  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  **Usage for Configurator Exports**:  ``` -qmk flash [-bl <bootloader>] [-c] [-e <var>=<value>] <configuratorExport.json> +qmk flash [-bl <bootloader>] [-c] [-e <var>=<value>] [-j <num_jobs>] <configuratorExport.json>  ```  **Usage for Keymaps**:  ``` -qmk flash -kb <keyboard_name> -km <keymap_name> [-bl <bootloader>] [-c] [-e <var>=<value>] +qmk flash -kb <keyboard_name> -km <keymap_name> [-bl <bootloader>] [-c] [-e <var>=<value>] [-j <num_jobs>]  ```  **Listing the Bootloaders** @@ -109,7 +120,7 @@ qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN]  ## `qmk console` -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`. +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`.  **Usage**: @@ -280,12 +291,12 @@ qmk list-keymaps -kb planck/ez  This command creates a new keyboard based on available templates. -This command will prompt for input to guide you though the generation process. +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.  **Usage**:  ``` -qmk new-keyboard +qmk new-keyboard [-kb KEYBOARD] [-t {avr,ps2avrgb}] -u USERNAME  ```  ## `qmk new-keymap` @@ -314,7 +325,18 @@ qmk clean [-a]  # Developer Commands -## `qmk cformat` +## `qmk format-text` + +This command formats text files to have proper line endings.  + +Every text file in the repository needs to have Unix (LF) line ending. +If you are working on **Windows**, you must ensure that line endings are corrected in order to get your PRs merged. + +``` +qmk format-text +``` + +## `qmk format-c`  This command formats C code using clang-format.  @@ -325,25 +347,25 @@ Run it with `-a` to format all core code, or pass filenames on the command line  **Usage for specified files**:  ``` -qmk cformat [file1] [file2] [...] [fileN] +qmk format-c [file1] [file2] [...] [fileN]  ```  **Usage for all core files**:  ``` -qmk cformat -a +qmk format-c -a  ```  **Usage for only changed files against origin/master**:  ``` -qmk cformat +qmk format-c  ```  **Usage for only changed files against branch_name**:  ``` -qmk cformat -b branch_name +qmk format-c -b branch_name  ```  ## `qmk docs` @@ -369,7 +391,7 @@ qmk generate-docs  ## `qmk generate-rgb-breathe-table` -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/`. +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/`.  **Usage**: @@ -399,14 +421,14 @@ $ qmk kle2json -f kle.txt -f  Ψ Wrote out to info.json  ``` -## `qmk pyformat` +## `qmk format-python`  This command formats python code in `qmk_firmware`.  **Usage**:  ``` -qmk pyformat +qmk format-python  ```  ## `qmk pytest` | 
