diff options
| author | Joel Challis <git@zvecr.com> | 2025-07-23 04:33:37 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-07-23 04:33:37 +0100 |
| commit | 74d64c7f43a9a1a0f6a0a26c981f1611ac0edaa3 (patch) | |
| tree | d76859f22ae870aa43e65c64e7b119f529124fa6 /docs/cli_commands.md | |
| parent | 7098252252ad17e14118d06da14d7fe62d807f83 (diff) | |
[docs] Align keyboard and keymap placeholders (#25509)
Diffstat (limited to 'docs/cli_commands.md')
| -rw-r--r-- | docs/cli_commands.md | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md index c6a7ffe191..54bf5cc123 100644 --- a/docs/cli_commands.md +++ b/docs/cli_commands.md | |||
| @@ -17,12 +17,12 @@ qmk compile [-c] <configuratorExport.json> | |||
| 17 | **Usage for Keymaps**: | 17 | **Usage for Keymaps**: |
| 18 | 18 | ||
| 19 | ``` | 19 | ``` |
| 20 | qmk compile [-c] [-e <var>=<value>] [-j <num_jobs>] [--compiledb] -kb <keyboard_name> -km <keymap_name> | 20 | qmk compile [-c] [-e <var>=<value>] [-j <num_jobs>] [--compiledb] -kb <keyboard> -km <keymap> |
| 21 | ``` | 21 | ``` |
| 22 | 22 | ||
| 23 | **Usage in Keyboard Directory**: | 23 | **Usage in Keyboard Directory**: |
| 24 | 24 | ||
| 25 | Must be in keyboard directory with a default keymap, or in keymap directory for keyboard, or supply one with `--keymap <keymap_name>` | 25 | Must be in keyboard directory with a default keymap, or in keymap directory for keyboard, or supply one with `--keymap <keymap>` |
| 26 | ``` | 26 | ``` |
| 27 | qmk compile | 27 | qmk compile |
| 28 | ``` | 28 | ``` |
| @@ -30,7 +30,7 @@ qmk compile | |||
| 30 | **Usage for building all keyboards that support a specific keymap**: | 30 | **Usage for building all keyboards that support a specific keymap**: |
| 31 | 31 | ||
| 32 | ``` | 32 | ``` |
| 33 | qmk compile -kb all -km <keymap_name> | 33 | qmk compile -kb all -km <keymap> |
| 34 | ``` | 34 | ``` |
| 35 | 35 | ||
| 36 | **Example**: | 36 | **Example**: |
| @@ -62,7 +62,7 @@ $ qmk compile | |||
| 62 | 62 | ||
| 63 | Must be under `qmk_firmware/layouts/`, and in a keymap folder. | 63 | Must be under `qmk_firmware/layouts/`, and in a keymap folder. |
| 64 | ``` | 64 | ``` |
| 65 | qmk compile -kb <keyboard_name> | 65 | qmk compile -kb <keyboard> |
| 66 | ``` | 66 | ``` |
| 67 | 67 | ||
| 68 | **Example**: | 68 | **Example**: |
| @@ -77,11 +77,11 @@ $ qmk compile -kb dz60 | |||
| 77 | 77 | ||
| 78 | It is possible to speed up compilation by adding the `-j`/`--parallel` flag. | 78 | It is possible to speed up compilation by adding the `-j`/`--parallel` flag. |
| 79 | ``` | 79 | ``` |
| 80 | qmk compile -j <num_jobs> -kb <keyboard_name> | 80 | qmk compile -j <num_jobs> -kb <keyboard> |
| 81 | ``` | 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. | 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 | ``` | 83 | ``` |
| 84 | qmk compile -j 0 -kb <keyboard_name> | 84 | qmk compile -j 0 -kb <keyboard> |
| 85 | ``` | 85 | ``` |
| 86 | 86 | ||
| 87 | **Compilation Database**: | 87 | **Compilation Database**: |
| @@ -120,7 +120,7 @@ qmk flash [-bl <bootloader>] [-c] [-e <var>=<value>] [-j <num_jobs>] <configurat | |||
| 120 | **Usage for Keymaps**: | 120 | **Usage for Keymaps**: |
| 121 | 121 | ||
| 122 | ``` | 122 | ``` |
| 123 | qmk flash -kb <keyboard_name> -km <keymap_name> [-bl <bootloader>] [-c] [-e <var>=<value>] [-j <num_jobs>] | 123 | qmk flash -kb <keyboard> -km <keymap_name> [-bl <bootloader>] [-c] [-e <var>=<value>] [-j <num_jobs>] |
| 124 | ``` | 124 | ``` |
| 125 | 125 | ||
| 126 | **Usage for pre-compiled firmwares**: | 126 | **Usage for pre-compiled firmwares**: |
