aboutsummaryrefslogtreecommitdiff
path: root/docs/cli.md
diff options
context:
space:
mode:
authorskullydazed <skullydazed@users.noreply.github.com>2020-01-24 11:31:16 -0800
committerErovia <Erovia@users.noreply.github.com>2020-01-24 20:31:16 +0100
commit5e65af3a76252bea6556d26add3061dea4918cc2 (patch)
treef44089f3f95e53e1b67d34db3c922a04b0a942f7 /docs/cli.md
parente4a0f841e19b4ddf86711cf79dc521d2f6f5e4ae (diff)
downloadqmk_firmware-5e65af3a76252bea6556d26add3061dea4918cc2.tar.gz
qmk_firmware-5e65af3a76252bea6556d26add3061dea4918cc2.zip
Beef up how `qmk doctor` works. (#7375)
* Beef up how `qmk doctor` works. * improve the `git submodule status` parsing. h/t @erovia * Fix whitespace and imports * yapf * Add documentation for the new doctor functionality * Replace type_unchanged() with str() * remove unused modules * Update lib/python/qmk/cli/doctor.py Co-Authored-By: Erovia <Erovia@users.noreply.github.com> Co-authored-by: Erovia <Erovia@users.noreply.github.com>
Diffstat (limited to 'docs/cli.md')
-rw-r--r--docs/cli.md18
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
144This command examines your environment and alerts you to potential build or flash problems. 144This 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```
149qmk doctor 149qmk doctor [-y] [-n]
150``` 150```
151 151
152**Examples**:
153
154Check your environment for problems and prompt to fix them:
155
156 qmk doctor
157
158Check your environment and automatically fix any problems found:
159
160 qmk doctor -y
161
162Check your environment and report problems only:
163
164 qmk doctor -n
165
152## `qmk json-keymap` 166## `qmk json-keymap`
153 167
154Creates a keymap.c from a QMK Configurator export. 168Creates a keymap.c from a QMK Configurator export.