diff options
Diffstat (limited to 'docs/cli.md')
-rw-r--r-- | docs/cli.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/cli.md b/docs/cli.md index fb7d17d2a..1c0952722 100644 --- a/docs/cli.md +++ b/docs/cli.md | |||
@@ -95,6 +95,30 @@ qmk compile <configuratorExport.json> | |||
95 | qmk compile -kb <keyboard_name> -km <keymap_name> | 95 | qmk compile -kb <keyboard_name> -km <keymap_name> |
96 | ``` | 96 | ``` |
97 | 97 | ||
98 | ## `qmk flash` | ||
99 | |||
100 | This command is similar to `qmk compile`, but can also target a bootloader. The bootloader is optional, and is set to `:flash` by default. | ||
101 | To specify a different bootloader, use `-bl <bootloader>`. Visit <https://docs.qmk.fm/#/flashing> | ||
102 | for more details of the available bootloaders. | ||
103 | |||
104 | **Usage for Configurator Exports**: | ||
105 | |||
106 | ``` | ||
107 | qmk flash <configuratorExport.json> -bl <bootloader> | ||
108 | ``` | ||
109 | |||
110 | **Usage for Keymaps**: | ||
111 | |||
112 | ``` | ||
113 | qmk flash -kb <keyboard_name> -km <keymap_name> -bl <bootloader> | ||
114 | ``` | ||
115 | |||
116 | **Listing the Bootloaders** | ||
117 | |||
118 | ``` | ||
119 | qmk flash -b | ||
120 | ``` | ||
121 | |||
98 | ## `qmk config` | 122 | ## `qmk config` |
99 | 123 | ||
100 | This command lets you configure the behavior of QMK. For the full `qmk config` documentation see [CLI Configuration](cli_configuration.md). | 124 | This command lets you configure the behavior of QMK. For the full `qmk config` documentation see [CLI Configuration](cli_configuration.md). |