diff options
| author | Erovia <erovia@users.noreply.github.com> | 2020-03-22 19:48:30 +0100 |
|---|---|---|
| committer | skullydazed <skullydazed@users.noreply.github.com> | 2020-04-08 09:31:14 -0700 |
| commit | 5cfc3ce02e3c8007ac42e8089ecc895771bb3bfb (patch) | |
| tree | cd57c376585c927e353190a785810b68ad9f9594 /docs/cli_development.md | |
| parent | 724f20ed32758b0c5d91ad4b7ba4a9348e152eeb (diff) | |
| download | firmware-5cfc3ce02e3c8007ac42e8089ecc895771bb3bfb.tar.gz firmware-5cfc3ce02e3c8007ac42e8089ecc895771bb3bfb.tar.bz2 firmware-5cfc3ce02e3c8007ac42e8089ecc895771bb3bfb.zip | |
Rebase on master, hide some other subcommands
The list of hidden subcommands were approved by @skullydazed ;)
Currently hidden if 'user.developer' is not True:
- cformat
- docs
- kle2json
- pyformat
- pytest
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 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. -*Tip*: Enable dev mode by `qmk config user.developer=True` +## Developer mode: + +If you intend to maintain keyboards and/or contribute to QMK, you can enable the CLI's "Developer" mode: + +`qmk config user.developer=True` + +This will allow you to see all available subcommands. +**Note:** You will have to install additional requirements: +```bash +python3 -m pip install -r requirements-dev.txt +``` # Subcommands |