diff options
Diffstat (limited to 'docs/cli_commands.md')
| -rw-r--r-- | docs/cli_commands.md | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md index 05e930607..581342093 100644 --- a/docs/cli_commands.md +++ b/docs/cli_commands.md | |||
| @@ -107,6 +107,54 @@ This command lets you configure the behavior of QMK. For the full `qmk config` d | |||
| 107 | qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN] | 107 | qmk config [-ro] [config_token1] [config_token2] [...] [config_tokenN] |
| 108 | ``` | 108 | ``` |
| 109 | 109 | ||
| 110 | ## `qmk console` | ||
| 111 | |||
| 112 | This command lets you connect to keyboard consoles to get debugging messages. It only works if your keyboard firmware has been compiled with `CONSOLE_ENABLED=yes`. | ||
| 113 | |||
| 114 | **Usage**: | ||
| 115 | |||
| 116 | ``` | ||
| 117 | qmk console [-d <pid>:<vid>[:<index>]] [-l] [-n] [-t] [-w <seconds>] | ||
| 118 | ``` | ||
| 119 | |||
| 120 | **Examples**: | ||
| 121 | |||
| 122 | Connect to all available keyboards and show their console messages: | ||
| 123 | |||
| 124 | ``` | ||
| 125 | qmk console | ||
| 126 | ``` | ||
| 127 | |||
| 128 | List all devices: | ||
| 129 | |||
| 130 | ``` | ||
| 131 | qmk console -l | ||
| 132 | ``` | ||
| 133 | |||
| 134 | Show only messages from clueboard/66/rev3 keyboards: | ||
| 135 | |||
| 136 | ``` | ||
| 137 | qmk console -d C1ED:2370 | ||
| 138 | ``` | ||
| 139 | |||
| 140 | Show only messages from the second clueboard/66/rev3: | ||
| 141 | |||
| 142 | ``` | ||
| 143 | qmk console -d C1ED:2370:2 | ||
| 144 | ``` | ||
| 145 | |||
| 146 | Show timestamps and VID:PID instead of names: | ||
| 147 | |||
| 148 | ``` | ||
| 149 | qmk console -n -t | ||
| 150 | ``` | ||
| 151 | |||
| 152 | Disable bootloader messages: | ||
| 153 | |||
| 154 | ``` | ||
| 155 | qmk console --no-bootloaders | ||
| 156 | ``` | ||
| 157 | |||
| 110 | ## `qmk doctor` | 158 | ## `qmk doctor` |
| 111 | 159 | ||
| 112 | 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. | 160 | 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. |
