diff options
Diffstat (limited to 'docs/cli_commands.md')
-rw-r--r-- | docs/cli_commands.md | 48 |
1 files changed, 0 insertions, 48 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md index 8fa7ad41d..06568afb4 100644 --- a/docs/cli_commands.md +++ b/docs/cli_commands.md | |||
@@ -118,54 +118,6 @@ 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 console` | ||
122 | |||
123 | 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`. | ||
124 | |||
125 | **Usage**: | ||
126 | |||
127 | ``` | ||
128 | qmk console [-d <pid>:<vid>[:<index>]] [-l] [-n] [-t] [-w <seconds>] | ||
129 | ``` | ||
130 | |||
131 | **Examples**: | ||
132 | |||
133 | Connect to all available keyboards and show their console messages: | ||
134 | |||
135 | ``` | ||
136 | qmk console | ||
137 | ``` | ||
138 | |||
139 | List all devices: | ||
140 | |||
141 | ``` | ||
142 | qmk console -l | ||
143 | ``` | ||
144 | |||
145 | Show only messages from clueboard/66/rev3 keyboards: | ||
146 | |||
147 | ``` | ||
148 | qmk console -d C1ED:2370 | ||
149 | ``` | ||
150 | |||
151 | Show only messages from the second clueboard/66/rev3: | ||
152 | |||
153 | ``` | ||
154 | qmk console -d C1ED:2370:2 | ||
155 | ``` | ||
156 | |||
157 | Show timestamps and VID:PID instead of names: | ||
158 | |||
159 | ``` | ||
160 | qmk console -n -t | ||
161 | ``` | ||
162 | |||
163 | Disable bootloader messages: | ||
164 | |||
165 | ``` | ||
166 | qmk console --no-bootloaders | ||
167 | ``` | ||
168 | |||
169 | ## `qmk doctor` | 121 | ## `qmk doctor` |
170 | 122 | ||
171 | 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. | 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. |