diff options
Diffstat (limited to 'docs/cli_commands.md')
-rw-r--r-- | docs/cli_commands.md | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md index 9113e3b02..520da06c4 100644 --- a/docs/cli_commands.md +++ b/docs/cli_commands.md | |||
@@ -118,6 +118,68 @@ This command lets you configure the behavior of QMK. For the full `qmk config` d | |||
118 | qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN] | 118 | qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN] |
119 | ``` | 119 | ``` |
120 | 120 | ||
121 | ## `qmk cd` | ||
122 | |||
123 | This command opens a new shell in your `qmk_firmware` directory. | ||
124 | |||
125 | Note that if you are already somewhere within `QMK_HOME` (for example, the `keyboards/` folder), nothing will happen. | ||
126 | |||
127 | To exit out into the parent shell, simply type `exit`. | ||
128 | |||
129 | **Usage**: | ||
130 | |||
131 | ``` | ||
132 | qmk cd | ||
133 | ``` | ||
134 | |||
135 | ## `qmk console` | ||
136 | |||
137 | 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`. | ||
138 | |||
139 | **Usage**: | ||
140 | |||
141 | ``` | ||
142 | qmk console [-d <pid>:<vid>[:<index>]] [-l] [-n] [-t] [-w <seconds>] | ||
143 | ``` | ||
144 | |||
145 | **Examples**: | ||
146 | |||
147 | Connect to all available keyboards and show their console messages: | ||
148 | |||
149 | ``` | ||
150 | qmk console | ||
151 | ``` | ||
152 | |||
153 | List all devices: | ||
154 | |||
155 | ``` | ||
156 | qmk console -l | ||
157 | ``` | ||
158 | |||
159 | Show only messages from clueboard/66/rev3 keyboards: | ||
160 | |||
161 | ``` | ||
162 | qmk console -d C1ED:2370 | ||
163 | ``` | ||
164 | |||
165 | Show only messages from the second clueboard/66/rev3: | ||
166 | |||
167 | ``` | ||
168 | qmk console -d C1ED:2370:2 | ||
169 | ``` | ||
170 | |||
171 | Show timestamps and VID:PID instead of names: | ||
172 | |||
173 | ``` | ||
174 | qmk console -n -t | ||
175 | ``` | ||
176 | |||
177 | Disable bootloader messages: | ||
178 | |||
179 | ``` | ||
180 | qmk console --no-bootloaders | ||
181 | ``` | ||
182 | |||
121 | ## `qmk doctor` | 183 | ## `qmk doctor` |
122 | 184 | ||
123 | This command examines your environment and alerts you to potential build or flash problems. It can fix many of them if you want it to. | 185 | This command examines your environment and alerts you to potential build or flash problems. It can fix many of them if you want it to. |