diff options
| author | Erovia <Erovia@users.noreply.github.com> | 2022-08-20 06:39:19 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-08-20 15:39:19 +1000 |
| commit | 5e2ffe7d8f4187109514147469d7db93e075f6f0 (patch) | |
| tree | 83552a38351b50f6ab175c6abd6070abcc3d78a0 /docs | |
| parent | 3bf36e8b04be5af9826fe3241d227efb185a4a31 (diff) | |
CLI: Teaching the CLI to flash binaries (#16584)
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Sergey Vlasov <sigprof@gmail.com>
Co-authored-by: Joel Challis <git@zvecr.com>
Co-authored-by: Nick Brassel <nick@tzarc.org>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/cli_commands.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md index 56767d962b..4608ed85b6 100644 --- a/docs/cli_commands.md +++ b/docs/cli_commands.md @@ -90,6 +90,8 @@ This command is similar to `qmk compile`, but can also target a bootloader. The This command is directory aware. It will automatically fill in KEYBOARD and/or KEYMAP if you are in a keyboard or keymap directory. +This command can also flash binary firmware files (hex or bin) such as the ones produced by [Configurator](https://config.qmk.fm). + **Usage for Configurator Exports**: ``` @@ -102,6 +104,21 @@ qmk flash [-bl <bootloader>] [-c] [-e <var>=<value>] [-j <num_jobs>] <configurat qmk flash -kb <keyboard_name> -km <keymap_name> [-bl <bootloader>] [-c] [-e <var>=<value>] [-j <num_jobs>] ``` +**Usage for pre-compiled firmwares**: + +**Note**: The microcontroller needs to be specified (`-m` argument) for keyboards with the following bootloaders: +* HalfKay +* QMK HID +* USBaspLoader + +ISP flashing is also supported with the following flashers and require the microcontroller to be specified: +* USBasp +* USBtinyISP + +``` +qmk flash [-m <microcontroller>] <compiledFirmware.[bin|hex]> +``` + **Listing the Bootloaders** ``` |