diff options
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 | |||
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` | ||
10 | |||
9 | # Subcommands | 11 | # Subcommands |
10 | 12 | ||
11 | [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. | 13 | [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. |