aboutsummaryrefslogtreecommitdiff
path: root/docs/cli_commands.md
diff options
context:
space:
mode:
authorZach White <skullydazed@gmail.com>2021-08-28 18:27:57 -0700
committerGitHub <noreply@github.com>2021-08-29 11:27:57 +1000
commitf155865804da332ac544e6a6bca0ca9035d3e818 (patch)
treeb2786ec3176fce4fff8af90de9bee174d2201e43 /docs/cli_commands.md
parent1ac3b3e9b6e794669db91d6d14c90b420b56bc26 (diff)
downloadqmk_firmware-f155865804da332ac544e6a6bca0ca9035d3e818.tar.gz
qmk_firmware-f155865804da332ac544e6a6bca0ca9035d3e818.zip
remove qmk console, which is now part of the global cli (#14206)
Diffstat (limited to 'docs/cli_commands.md')
-rw-r--r--docs/cli_commands.md48
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
118qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN] 118qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN]
119``` 119```
120 120
121## `qmk console`
122
123This 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```
128qmk console [-d <pid>:<vid>[:<index>]] [-l] [-n] [-t] [-w <seconds>]
129```
130
131**Examples**:
132
133Connect to all available keyboards and show their console messages:
134
135```
136qmk console
137```
138
139List all devices:
140
141```
142qmk console -l
143```
144
145Show only messages from clueboard/66/rev3 keyboards:
146
147```
148qmk console -d C1ED:2370
149```
150
151Show only messages from the second clueboard/66/rev3:
152
153```
154qmk console -d C1ED:2370:2
155```
156
157Show timestamps and VID:PID instead of names:
158
159```
160qmk console -n -t
161```
162
163Disable bootloader messages:
164
165```
166qmk console --no-bootloaders
167```
168
169## `qmk doctor` 121## `qmk doctor`
170 122
171This command examines your environment and alerts you to potential build or flash problems. It can fix many of them if you want it to. 123This command examines your environment and alerts you to potential build or flash problems. It can fix many of them if you want it to.