summaryrefslogtreecommitdiff
path: root/docs/cli_commands.md
diff options
context:
space:
mode:
authorJoel Challis <git@zvecr.com>2024-05-30 10:00:28 +0100
committerGitHub <noreply@github.com>2024-05-30 10:00:28 +0100
commitb39285807e1d21300e8a5dbbf6f2c43a8aab3494 (patch)
tree311895a73c967f5d322885c1a9f1073a7b9f1b91 /docs/cli_commands.md
parent6ef97172889ccd5db376b2a9f8825489e24fdac4 (diff)
[docs] Fix code blocks overflowing page width (#23829)
Fix code blocks overflowing page width
Diffstat (limited to 'docs/cli_commands.md')
-rw-r--r--docs/cli_commands.md58
1 files changed, 43 insertions, 15 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md
index 6f82d9c9de..5a85356e70 100644
--- a/docs/cli_commands.md
+++ b/docs/cli_commands.md
@@ -254,15 +254,21 @@ qmk doctor [-y] [-n]
254 254
255Check your environment for problems and prompt to fix them: 255Check your environment for problems and prompt to fix them:
256 256
257 qmk doctor 257```
258qmk doctor
259```
258 260
259Check your environment and automatically fix any problems found: 261Check your environment and automatically fix any problems found:
260 262
261 qmk doctor -y 263```
264qmk doctor -y
265```
262 266
263Check your environment and report problems only: 267Check your environment and report problems only:
264 268
265 qmk doctor -n 269```
270qmk doctor -n
271```
266 272
267## `qmk format-json` 273## `qmk format-json`
268 274
@@ -290,15 +296,21 @@ This command is directory aware. It will automatically fill in KEYBOARD and/or K
290 296
291Show basic information for a keyboard: 297Show basic information for a keyboard:
292 298
293 qmk info -kb planck/rev5 299```
300qmk info -kb planck/rev5
301```
294 302
295Show the matrix for a keyboard: 303Show the matrix for a keyboard:
296 304
297 qmk info -kb ergodox_ez -m 305```
306qmk info -kb ergodox_ez -m
307```
298 308
299Show a JSON keymap for a keyboard: 309Show a JSON keymap for a keyboard:
300 310
301 qmk info -kb clueboard/california -km default 311```
312qmk info -kb clueboard/california -km default
313```
302 314
303## `qmk json2c` 315## `qmk json2c`
304 316
@@ -350,7 +362,9 @@ This command is directory aware. It will automatically fill in KEYBOARD and/or K
350 362
351Do a basic lint check: 363Do a basic lint check:
352 364
353 qmk lint -kb rominronin/katana60/rev2 365```
366qmk lint -kb rominronin/katana60/rev2
367```
354 368
355## `qmk list-keyboards` 369## `qmk list-keyboards`
356 370
@@ -789,16 +803,22 @@ qmk pytest [-t TEST]
789 803
790Run entire test suite: 804Run entire test suite:
791 805
792 qmk pytest 806```
807qmk pytest
808```
793 809
794Run test group: 810Run test group:
795 811
796 qmk pytest -t qmk.tests.test_cli_commands 812```
813qmk pytest -t qmk.tests.test_cli_commands
814```
797 815
798Run single test: 816Run single test:
799 817
800 qmk pytest -t qmk.tests.test_cli_commands.test_c2json 818```
801 qmk pytest -t qmk.tests.test_qmk_path 819qmk pytest -t qmk.tests.test_cli_commands.test_c2json
820qmk pytest -t qmk.tests.test_qmk_path
821```
802 822
803## `qmk painter-convert-graphics` 823## `qmk painter-convert-graphics`
804 824
@@ -835,16 +855,24 @@ options:
835 855
836Run entire test suite: 856Run entire test suite:
837 857
838 qmk test-c 858```
859qmk test-c
860```
839 861
840List available tests: 862List available tests:
841 863
842 qmk test-c --list 864```
865qmk test-c --list
866```
843 867
844Run matching test: 868Run matching test:
845 869
846 qmk test-c --test unicode* 870```
871qmk test-c --test unicode*
872```
847 873
848Run single test: 874Run single test:
849 875
850 qmk test-c --test basic 876```
877qmk test-c --test basic
878```