diff options
Diffstat (limited to 'docs/cli_development.md')
| -rw-r--r-- | docs/cli_development.md | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/docs/cli_development.md b/docs/cli_development.md index e41afc42f..2a967de4a 100644 --- a/docs/cli_development.md +++ b/docs/cli_development.md | |||
| @@ -6,7 +6,17 @@ This document has useful information for developers wishing to write new `qmk` s | |||
| 6 | 6 | ||
| 7 | The QMK CLI operates using the subcommand pattern made famous by git. The main `qmk` script is simply there to setup the environment and pick the correct entrypoint to run. Each subcommand is a self-contained module with an entrypoint (decorated by `@cli.subcommand()`) that performs some action and returns a shell returncode, or None. | 7 | The QMK CLI operates using the subcommand pattern made famous by git. The main `qmk` script is simply there to setup the environment and pick the correct entrypoint to run. Each subcommand is a self-contained module with an entrypoint (decorated by `@cli.subcommand()`) that performs some action and returns a shell returncode, or None. |
| 8 | 8 | ||
| 9 | *Tip*: Enable dev mode by `qmk config user.developer=True` | 9 | ## Developer mode: |
| 10 | |||
| 11 | If you intend to maintain keyboards and/or contribute to QMK, you can enable the CLI's "Developer" mode: | ||
| 12 | |||
| 13 | `qmk config user.developer=True` | ||
| 14 | |||
| 15 | This will allow you to see all available subcommands. | ||
| 16 | **Note:** You will have to install additional requirements: | ||
| 17 | ```bash | ||
| 18 | python3 -m pip install -r requirements-dev.txt | ||
| 19 | ``` | ||
| 10 | 20 | ||
| 11 | # Subcommands | 21 | # Subcommands |
| 12 | 22 | ||
