diff options
| author |  Erovia <erovia@users.noreply.github.com> | 2019-11-27 21:27:06 +0100 |
|---|---|---|
| committer |  skullydazed <skullydazed@users.noreply.github.com> | 2020-04-08 09:31:14 -0700 |
| commit | c61f016fa491502920941fd03cdab6453d126e67 (patch) | |
| tree | 1f8f6b4cbaf2b158604d47f01dc42fc69cac365a /docs/cli_development.md | |
| parent | ea7e40bae17897fbc613e0965d076a7a25b14ea6 (diff) | |
| download | qmk_firmware-c61f016fa491502920941fd03cdab6453d126e67.tar.gz | |
CLI: Add development mode support
Hide development specific options and don't require dev modules unless
`user.developer` is set to `True`.
Diffstat (limited to 'docs/cli_development.md')
| -rw-r--r-- | docs/cli_development.md | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/cli_development.md b/docs/cli_development.md index cc8c59d06..e41afc42f 100644 --- a/docs/cli_development.md +++ b/docs/cli_development.md @@ -6,6 +6,8 @@ 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` + # Subcommands [MILC](https://github.com/clueboard/milc) is the CLI framework `qmk` uses to handle argument parsing, configuration, logging, and many other features. It lets you focus on writing your tool without wasting your time writing glue code. |