auri.ee
keyboard stuff
1# Command
2
3Command, formerly known as Magic, is a way to change your keyboard's behavior without having to flash or unplug it to use [Bootmagic](bootmagic). There is a lot of overlap between this functionality and the [Magic Keycodes](../keycodes_magic). Wherever possible we encourage you to use that feature instead of Command.
4
5On some keyboards Command is disabled by default. If this is the case, it must be explicitly enabled in your `rules.mk`:
6
7```make
8COMMAND_ENABLE = yes
9```
10
11## Usage
12
13To use Command, hold down the key combination defined by the `IS_COMMAND()` macro. By default this is Left Shift+Right Shift. Then, press the key corresponding to the command you want. For example, to output the current QMK version to the QMK Toolbox console, press Left Shift+Right Shift+`V`.
14
15## Configuration
16
17If you would like to change the key assignments for Command, `#define` these in your `config.h` at either the keyboard or keymap level. All keycode assignments here must omit the `KC_` prefix.
18
19|Define |Default |Description |
20|------------------------------------|--------------------------------|------------------------------------------------|
21|`IS_COMMAND()` |`(get_mods() == MOD_MASK_SHIFT)`|The key combination to activate Command |
22|`MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS` |`true` |Set default layer with the Function row |
23|`MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS` |`true` |Set default layer with the number keys |
24|`MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM`|`false` |Set default layer with `MAGIC_KEY_LAYER0..9` |
25|`MAGIC_KEY_DEBUG` |`D` |Toggle debugging over serial |
26|`MAGIC_KEY_DEBUG_MATRIX` |`X` |Toggle key matrix debugging |
27|`MAGIC_KEY_DEBUG_KBD` |`K` |Toggle keyboard debugging |
28|`MAGIC_KEY_DEBUG_MOUSE` |`M` |Toggle mouse debugging |
29|`MAGIC_KEY_CONSOLE` |`C` |Enable the Command console |
30|`MAGIC_KEY_VERSION` |`V` |Print the running QMK version to the console |
31|`MAGIC_KEY_STATUS` |`S` |Print the current keyboard status to the console|
32|`MAGIC_KEY_HELP` |`H` |Print Command help to the console |
33|`MAGIC_KEY_HELP_ALT` |`SLASH` |Print Command help to the console (alternate) |
34|`MAGIC_KEY_LAYER0` |`0` |Make layer 0 the default layer |
35|`MAGIC_KEY_LAYER0_ALT` |`GRAVE` |Make layer 0 the default layer (alternate) |
36|`MAGIC_KEY_LAYER1` |`1` |Make layer 1 the default layer |
37|`MAGIC_KEY_LAYER2` |`2` |Make layer 2 the default layer |
38|`MAGIC_KEY_LAYER3` |`3` |Make layer 3 the default layer |
39|`MAGIC_KEY_LAYER4` |`4` |Make layer 4 the default layer |
40|`MAGIC_KEY_LAYER5` |`5` |Make layer 5 the default layer |
41|`MAGIC_KEY_LAYER6` |`6` |Make layer 6 the default layer |
42|`MAGIC_KEY_LAYER7` |`7` |Make layer 7 the default layer |
43|`MAGIC_KEY_LAYER8` |`8` |Make layer 8 the default layer |
44|`MAGIC_KEY_LAYER9` |`9` |Make layer 9 the default layer |
45|`MAGIC_KEY_BOOTLOADER` |`B` |Jump to bootloader |
46|`MAGIC_KEY_BOOTLOADER_ALT` |`ESC` |Jump to bootloader (alternate) |
47|`MAGIC_KEY_LOCK` |`CAPS` |Lock the keyboard so nothing can be typed |
48|`MAGIC_KEY_EEPROM` |`E` |Print stored EEPROM config to the console |
49|`MAGIC_KEY_EEPROM_CLEAR` |`BSPACE` |Clear the EEPROM |
50|`MAGIC_KEY_NKRO` |`N` |Toggle N-Key Rollover (NKRO) |
51|`MAGIC_KEY_SLEEP_LED` |`Z` |Toggle LED when computer is sleeping |