drashna/qmk_firmware
1
0
Fork 0
Code Activity Actions

Rebase on master, hide some other subcommands

Browse source 
The list of hidden subcommands were approved by @skullydazed ;)
Currently hidden if 'user.developer' is not True:

  - cformat
  - docs
  - kle2json
  - pyformat
  - pytest
This commit is contained in:
Erovia 2020-03-22 19:48:30 +01:00 • committed by skullydazed
parent 724f20ed32
commit 5cfc3ce02e
7 changed files with 25 additions and 255 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/cli_development.md
View file

@ -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