aboutsummaryrefslogtreecommitdiff
path: root/docs/cli.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/cli.md')
-rw-r--r--docs/cli.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/cli.md b/docs/cli.md
index e655b0ee8..1c0952722 100644
--- a/docs/cli.md
+++ b/docs/cli.md
@@ -95,6 +95,30 @@ qmk compile <configuratorExport.json>
95qmk compile -kb <keyboard_name> -km <keymap_name> 95qmk compile -kb <keyboard_name> -km <keymap_name>
96``` 96```
97 97
98## `qmk flash`
99
100This command is similar to `qmk compile`, but can also target a bootloader. The bootloader is optional, and is set to `:flash` by default.
101To specify a different bootloader, use `-bl <bootloader>`. Visit <https://docs.qmk.fm/#/flashing>
102for more details of the available bootloaders.
103
104**Usage for Configurator Exports**:
105
106```
107qmk flash <configuratorExport.json> -bl <bootloader>
108```
109
110**Usage for Keymaps**:
111
112```
113qmk flash -kb <keyboard_name> -km <keymap_name> -bl <bootloader>
114```
115
116**Listing the Bootloaders**
117
118```
119qmk flash -b
120```
121
98## `qmk config` 122## `qmk config`
99 123
100This command lets you configure the behavior of QMK. For the full `qmk config` documentation see [CLI Configuration](cli_configuration.md). 124This command lets you configure the behavior of QMK. For the full `qmk config` documentation see [CLI Configuration](cli_configuration.md).
@@ -135,6 +159,28 @@ Creates a keymap.c from a QMK Configurator export.
135qmk json-keymap [-o OUTPUT] filename 159qmk json-keymap [-o OUTPUT] filename
136``` 160```
137 161
162## `qmk kle2json`
163
164This command allows you to convert from raw KLE data to QMK Configurator JSON. It accepts either an absolute file path, or a file name in the current directory. By default it will not overwrite `info.json` if it is already present. Use the `-f` or `--force` flag to overwrite.
165
166**Usage**:
167
168```
169qmk kle2json [-f] <filename>
170```
171
172**Examples**:
173
174```
175$ qmk kle2json kle.txt
176☒ File info.json already exists, use -f or --force to overwrite.
177```
178
179```
180$ qmk kle2json -f kle.txt -f
181Ψ Wrote out to info.json
182```
183
138## `qmk list-keyboards` 184## `qmk list-keyboards`
139 185
140This command lists all the keyboards currently defined in `qmk_firmware` 186This command lists all the keyboards currently defined in `qmk_firmware`