summaryrefslogtreecommitdiffstats
path: root/docs/cli_development.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/cli_development.md')
-rw-r--r--docs/cli_development.md12
1 files changed, 11 insertions, 1 deletions
diff --git a/docs/cli_development.md b/docs/cli_development.md
index e41afc42f4..2a967de4ab 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