Henry-Hiles/qmk_userspace
1
0
Fork 0
forked from mirrors/qmk_userspace
Code Pull requests Activity

CLI: Add development mode support

Browse source 
Hide development specific options and don't require dev modules unless
`user.developer` is set to `True`.
This commit is contained in:
Erovia 2019-11-27 21:27:06 +01:00 • committed by skullydazed
parent ea7e40bae1
commit c61f016fa4
8 changed files with 302 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/cli_development.md
View file

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