diff options
Diffstat (limited to 'docs/cli.md')
| -rw-r--r-- | docs/cli.md | 18 |
1 files changed, 16 insertions, 2 deletions
diff --git a/docs/cli.md b/docs/cli.md index 1c0952722..4f328a75a 100644 --- a/docs/cli.md +++ b/docs/cli.md | |||
| @@ -141,14 +141,28 @@ qmk docs [-p PORT] | |||
| 141 | 141 | ||
| 142 | ## `qmk doctor` | 142 | ## `qmk doctor` |
| 143 | 143 | ||
| 144 | This command examines your environment and alerts you to potential build or flash problems. | 144 | 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. |
| 145 | 145 | ||
| 146 | **Usage**: | 146 | **Usage**: |
| 147 | 147 | ||
| 148 | ``` | 148 | ``` |
| 149 | qmk doctor | 149 | qmk doctor [-y] [-n] |
| 150 | ``` | 150 | ``` |
| 151 | 151 | ||
| 152 | **Examples**: | ||
| 153 | |||
| 154 | Check your environment for problems and prompt to fix them: | ||
| 155 | |||
| 156 | qmk doctor | ||
| 157 | |||
| 158 | Check your environment and automatically fix any problems found: | ||
| 159 | |||
| 160 | qmk doctor -y | ||
| 161 | |||
| 162 | Check your environment and report problems only: | ||
| 163 | |||
| 164 | qmk doctor -n | ||
| 165 | |||
| 152 | ## `qmk json-keymap` | 166 | ## `qmk json-keymap` |
| 153 | 167 | ||
| 154 | Creates a keymap.c from a QMK Configurator export. | 168 | Creates a keymap.c from a QMK Configurator export. |
