summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorZach White <skullydazed@gmail.com>2021-01-16 15:13:04 -0800
committerGitHub <noreply@github.com>2021-01-16 15:13:04 -0800
commitd9785ec31339d7f80279fd3d1005f76689ed2f6a (patch)
tree01f9e771367cfcd18d347eef7f85ce78a3b5ba50 /docs
parentc628408688306ed3e970505268cc4a235af8a5ff (diff)
Improve the compile and flash subcommands (#11334)
* add support for --clean to compile and flash

* compile standalone JSON keymaps without polluting the tree

* Add support for passing environment vars to make

* make flake8 happy

* document changes to qmk compile and flash

* add -e support to json export compiling

* Fix python 3.6

* honor $MAKE

* add support for parallel builds
Diffstat (limited to 'docs')
-rw-r--r--docs/cli_commands.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md
index 61ce1aa2a4..5ab49abd27 100644
--- a/docs/cli_commands.md
+++ b/docs/cli_commands.md
@@ -11,13 +11,13 @@ This command is directory aware. It will automatically fill in KEYBOARD and/or K
 **Usage for Configurator Exports**:
 
 ```
-qmk compile <configuratorExport.json>
+qmk compile [-c] <configuratorExport.json>
 ```
 
 **Usage for Keymaps**:
 
 ```
-qmk compile -kb <keyboard_name> -km <keymap_name>
+qmk compile [-c] [-e <var>=<value>] -kb <keyboard_name> -km <keymap_name>
 ```
 
 **Usage in Keyboard Directory**:  
@@ -82,13 +82,13 @@ This command is directory aware. It will automatically fill in KEYBOARD and/or K
 **Usage for Configurator Exports**:
 
 ```
-qmk flash <configuratorExport.json> -bl <bootloader>
+qmk flash [-bl <bootloader>] [-c] [-e <var>=<value>] <configuratorExport.json>
 ```
 
 **Usage for Keymaps**:
 
 ```
-qmk flash -kb <keyboard_name> -km <keymap_name> -bl <bootloader>
+qmk flash -kb <keyboard_name> -km <keymap_name> [-bl <bootloader>] [-c] [-e <var>=<value>]
 ```
 
 **Listing the Bootloaders**