docs/feature_terminal.md

   1 # Terminal
   2
   3 > This feature is currently *huge* at 4400 bytes, and should probably only be put on boards with a lot of memory, or for fun.
   4
   5 The terminal feature is a command-line-like interface designed to communicate through a text editor with keystrokes. It's beneficial to turn off auto-indent features in your editor.
   6
   7 To enable, stick this in your `rules.mk` or `Makefile`:
   8
   9     TERMINAL_ENABLE = yes
  10
  11 And use the `TERM_ON` and `TERM_OFF` keycodes to turn it on or off.
  12
  13 When enabled, a `> ` prompt will appear, where you'll be able to type, backspace (a bell will ding if you reach the beginning and audio is enabled), and hit enter to send the command. Arrow keys are currently disabled so it doesn't get confused. Moving your cursor around with the mouse is discouraged.
  14
  15 `#define TERMINAL_HELP` enables some other output helpers that aren't really needed with this page.
  16
  17 ## Future ideas
  18
  19 * Keyboard/user-extendable commands
  20 * Smaller footprint
  21 * Arrow key support
  22 * Command history
  23 * SD card support
  24 * LCD support for buffer display
  25 * Keycode -> name string LUT
  26 * Layer status
  27 * *Analog/digital port read/write*
  28 * RGB mode stuff
  29 * Macro definitions
  30 * EEPROM read/write
  31 * Audio control
  32
  33 ## Current commands
  34
  35 ### `about`
  36
  37 Prints out the current version of QMK with a build date:
  38
  39 ```
  40 > about
  41 QMK Firmware
  42   v0.5.115-7-g80ed73-dirty
  43   Built: 2017-08-29-20:24:44
  44 ```
  45
  46 ### `help`
  47
  48 Prints out the available commands:
  49
  50 ```
  51 > help
  52 commands available:
  53   about help keycode keymap exit
  54 ```
  55
  56 ### `keycode <layer> <row> <col>`
  57
  58 Prints out the keycode value of a certain layer, row, and column:
  59
  60 ```
  61 > keycode 0 1 0
  62 0x29 (41)
  63 ```
  64
  65 ### `keymap <layer>`
  66
  67 Prints out the entire keymap for a certain layer
  68
  69 ```
  70 > keymap 0
  71 0x002b, 0x0014, 0x001a, 0x0008, 0x0015, 0x0017, 0x001c, 0x0018, 0x000c, 0x0012, 0x0013, 0x002a,
  72 0x0029, 0x0004, 0x0016, 0x0007, 0x0009, 0x000a, 0x000b, 0x000d, 0x000e, 0x000f, 0x0033, 0x0034,
  73 0x00e1, 0x001d, 0x001b, 0x0006, 0x0019, 0x0005, 0x0011, 0x0010, 0x0036, 0x0037, 0x0038, 0x0028,
  74 0x5cd6, 0x00e0, 0x00e2, 0x00e3, 0x5cd4, 0x002c, 0x002c, 0x5cd5, 0x0050, 0x0051, 0x0052, 0x004f,
  75 >
  76 ```
  77
  78 ### `exit`
  79
  80 Exits the terminal - same as `TERM_OFF`.