aboutsummaryrefslogtreecommitdiff
path: root/docs/cli_commands.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/cli_commands.md')
-rw-r--r--docs/cli_commands.md37
1 files changed, 35 insertions, 2 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md
index eff5321bd..bb0de3c0d 100644
--- a/docs/cli_commands.md
+++ b/docs/cli_commands.md
@@ -6,6 +6,8 @@
6 6
7This command allows you to compile firmware from any directory. You can compile JSON exports from <https://config.qmk.fm>, compile keymaps in the repo, or compile the keyboard in the current working directory. 7This command allows you to compile firmware from any directory. You can compile JSON exports from <https://config.qmk.fm>, compile keymaps in the repo, or compile the keyboard in the current working directory.
8 8
9This command is directory aware. It will automatically fill in KEYBOARD and/or KEYMAP if you are in a keyboard or keymap directory.
10
9**Usage for Configurator Exports**: 11**Usage for Configurator Exports**:
10 12
11``` 13```
@@ -73,8 +75,9 @@ $ qmk compile -kb dz60
73 75
74## `qmk flash` 76## `qmk flash`
75 77
76This command is similar to `qmk compile`, but can also target a bootloader. The bootloader is optional, and is set to `:flash` by default. 78This 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.
77To specify a different bootloader, use `-bl <bootloader>`. Visit the [Flashing Firmware](flashing.md) guide for more details of the available bootloaders. 79
80This command is directory aware. It will automatically fill in KEYBOARD and/or KEYMAP if you are in a keyboard or keymap directory.
78 81
79**Usage for Configurator Exports**: 82**Usage for Configurator Exports**:
80 83
@@ -128,6 +131,32 @@ Check your environment and report problems only:
128 131
129 qmk doctor -n 132 qmk doctor -n
130 133
134## `qmk info`
135
136Displays information about keyboards and keymaps in QMK. You can use this to get information about a keyboard, show the layouts, display the underlying key matrix, or to pretty-print JSON keymaps.
137
138**Usage**:
139
140```
141qmk info [-f FORMAT] [-m] [-l] [-km KEYMAP] [-kb KEYBOARD]
142```
143
144This command is directory aware. It will automatically fill in KEYBOARD and/or KEYMAP if you are in a keyboard or keymap directory.
145
146**Examples**:
147
148Show basic information for a keyboard:
149
150 qmk info -kb planck/rev5
151
152Show the matrix for a keyboard:
153
154 qmk info -kb ergodox_ez -m
155
156Show a JSON keymap for a keyboard:
157
158 qmk info -kb clueboard/california -km default
159
131## `qmk json2c` 160## `qmk json2c`
132 161
133Creates a keymap.c from a QMK Configurator export. 162Creates a keymap.c from a QMK Configurator export.
@@ -152,6 +181,8 @@ qmk list-keyboards
152 181
153This command lists all the keymaps for a specified keyboard (and revision). 182This command lists all the keymaps for a specified keyboard (and revision).
154 183
184This command is directory aware. It will automatically fill in KEYBOARD if you are in a keyboard directory.
185
155**Usage**: 186**Usage**:
156 187
157``` 188```
@@ -162,6 +193,8 @@ qmk list-keymaps -kb planck/ez
162 193
163This command creates a new keymap based on a keyboard's existing default keymap. 194This command creates a new keymap based on a keyboard's existing default keymap.
164 195
196This command is directory aware. It will automatically fill in KEYBOARD and/or KEYMAP if you are in a keyboard or keymap directory.
197
165**Usage**: 198**Usage**:
166 199
167``` 200```