# Vial CLI tool
[](https://crates.io/crates/vitaly)
[](https://docs.rs/crate/vitaly/)
[](https://opensource.org/licenses/MIT)
Vial CLI tool allows to configure keyboard through VIA/Vial protocol with command line interface.
It supports QMK keycodes notation together with aliases.
Keys, encoders, combos, macros, tap dances, key overrides and alt repeat keys are supported.
RGB lighting control is supported too.
Non-colored underglow is not supported for now because there is no devices with such features around me.
Tool support --help for tool as a whole and for all subcommands.
## Installation
vitaly might be installed with cargo on macosx, linux and windows
```
cargo install vitaly
```
On linux you'll need to install libudev-dev depending on your linux dist something like
```
sudo apt install libudev-dev
```
On macosx and linux you can also use homebew to install vitaly with command
```
brew install bskaplou/tap/vitaly
```
Prebuilt binary and installation instructions for Windows, MacOSX, Linux are here https://github.com/bskaplou/vitaly/releases/latest
## Development
Just edit files and run following command to run tool in debug mode
```
cargo run -- <your_options>
```
## Global options
### Identifier
By default tool runs subcommands on all connected devices.
Option --id/-i can be used to select particular device.
For example
```
❯ vitaly devices # all devices
Product name: "Keychron K6 Pro" id: 611,
Manufacturer name: "Keychron", id: 13364,
Release: 256, Serial: "", Path: "DevSrvsID:4294971185"
Product name: "silakka54" id: 4626,
Manufacturer name: "Squalius-cephalus", id: 65261,
Release: 256, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4296802461"
❯ vitaly -i 611 devices # single device
Product name: "Keychron K6 Pro" id: 611,
Manufacturer name: "Keychron", id: 13364,
Release: 256, Serial: "", Path: "DevSrvsID:4294971185"
```
### Devices subcommand
Devices subcommand allows to list compatible devices. For example
```
❯ vitaly devices
Product name: "Keychron K6 Pro" id: 611,
Manufacturer name: "Keychron", id: 13364,
Release: 256, Serial: "", Path: "DevSrvsID:4294971185"
Product name: "silakka54" id: 4626,
Manufacturer name: "Squalius-cephalus", id: 65261,
Release: 256, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4296802461"
```
Flag -c allows to list devices capabilities as well. For example
```
❯ vitaly devices -c
Product name: "Keychron K6 Pro" id: 611,
Manufacturer name: "Keychron", id: 13364,
Release: 256, Serial: "", Path: "DevSrvsID:4294971185"
Capabilities:
via_version: 12
vial_version: 0
companion_hid_version: 1
layer_count: 5
tap_dance_count: 0
combo_count: 0
key_override_count: 0
alt_repeat_key_count: 0
caps_word: false
layer_lock: false
Product name: "silakka54" id: 4626,
Manufacturer name: "Squalius-cephalus", id: 65261,
Release: 256, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4296802461"
Capabilities:
via_version: 9
vial_version: 6
companion_hid_version: 1
layer_count: 8
tap_dance_count: 32
combo_count: 32
key_override_count: 32
alt_repeat_key_count: 32
caps_word: true
layer_lock: true
```
### Lock subcommand
Lock subcommand allows to check lock status and to lock/unlock keyboard.
```
❯ vitaly lock
Product name: "silakka54" id: 4626,
Manufacturer name: "Squalius-cephalus", id: 65261,
Release: 256, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4316856206"
Device is locked: true
```
To unlock keyboard run it with `-u` option and follow instructions
```
❯ vitaly lock -u
Product name: "silakka54" id: 4626,
Manufacturer name: "Squalius-cephalus", id: 65261,
Release: 256, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4316856206"
Device is locked: true
Starting unlock process...
Push marked buttons and keep then pushed to unlock...
...
Seconds remaining: 0 keep pushing...
Device is locked: false
```
To lock keyboard run it with `-l` option
```
❯ vitaly lock -l
Product name: "silakka54" id: 4626,
Manufacturer name: "Squalius-cephalus", id: 65261,
Release: 256, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4316856206"
Locking keyboard...
Device is locked: true
```
### Settings subcommand
Settings subcommand allows to list and alter keyboard settings.
Settings in list are addressed by qsid - QMK setting identifier and with bit for boolean settings encoded into bits.
It allows to dump full list of settings together with current values as follows
```
❯ vitaly -i 4626 settings
Product name: "silakka54" id: 4626,
Manufacturer name: "Squalius-cephalus", id: 65261,
Release: 256, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4296802461"
Magic:
21.0) Swap Caps Lock and Left Control = false
21.1) Treat Caps Lock as Control = false
21.2) Swap Left Alt and GUI = false
21.3) Swap Right Alt and GUI = false
21.4) Disable the GUI keys = false
21.5) Swap ` and Escape = false
21.6) Swap \ and Backspace = false
21.7) Enable N-key rollover = false
21.8) Swap Left Control and GUI = false
21.9) Swap Right Control and GUI = false
Grave Escape:
1.0) Always send Escape if Alt is pressed = false
1.1) Always send Escape if Control is pressed = false
1.2) Always send Escape if GUI is pressed = false
1.3) Always send Escape if Shift is pressed = false
Tap-Hold:
7) Tapping Term = 200
22) Permissive Hold = false
23) Hold On Other Key Press = false
24) Retro Tapping = false
25) Quick Tap Term = 200
18) Tap Code Delay = 0
19) Tap Hold Caps Delay = 80
20) Tapping Toggle = 5
26) Chordal Hold = false
27) Flow Tap = 0
Auto Shift:
3.0) Enable = false
3.1) Enable for modifiers = false
4) Timeout = 175
3.2) Do not Auto Shift special keys = false
3.3) Do not Auto Shift numeric keys = false
3.4) Do not Auto Shift alpha characters = false
3.5) Enable keyrepeat = false
3.6) Disable keyrepeat when timeout is exceeded = false
Combo:
2) Time out period for combos = 30
One Shot Keys:
5) Tapping this number of times holds the key until tapped once again = 5
6) Time (in ms) before the one shot key is released = 5000
Mouse keys:
9) Delay between pressing a movement key and cursor movement = 10
10) Time between cursor movements in milliseconds = 20
11) Step size = 8
12) Maximum cursor speed at which acceleration stops = 10
13) Time until maximum cursor speed is reached = 30
14) Delay between pressing a wheel key and wheel movement = 10
15) Time between wheel movements = 80
16) Maximum number of scroll steps per scroll action = 8
17) Time until maximum scroll speed is reached = 40
```
It also allows to dump single setting if called with option --qsid/-q as follows
```
❯ vitaly -i 4626 settings --qsid 6
Product name: "silakka54" id: 4626,
Manufacturer name: "Squalius-cephalus", id: 65261,
Release: 256, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4296802461"
6) Time (in ms) before the one shot key is released = 5000
```
It allows to alter setting if called with options -q and -v while -q addresses setting to be altered and -v passess desired value as follows
```
❯ vitaly -i 4626 settings --qsid 6 -v 4000
Product name: "silakka54" id: 4626,
Manufacturer name: "Squalius-cephalus", id: 65261,
Release: 256, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4316856206"
Option "Time (in ms) before the one shot key is released" = 4000 now
```
Boolean option example
```
❯ vitaly -i 4626 settings -q 26
Product name: "silakka54" id: 4626,
Manufacturer name: "Squalius-cephalus", id: 65261,
Release: 256, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4316856206"
26) Chordal Hold = false
```
Boolean option encoded into bit
```
❯ vitaly -i 4626 settings -q 3.2 -v true
Product name: "silakka54" id: 4626,
Manufacturer name: "Squalius-cephalus", id: 65261,
Release: 256, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4316856206"
Option "Do not Auto Shift special keys" = true now
❯ vitaly -i 4626 settings -q 3.2
Product name: "silakka54" id: 4626,
Manufacturer name: "Squalius-cephalus", id: 65261,
Release: 256, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4316856206"
3.2) Do not Auto Shift special keys = true
```
It also allows to reset all settings to default values if called with option --reset/-r.
### Layers subcommand
Layers subcommand is designed to help with visual layers dumping
It can dump button wiring positings if called with option positions
```
❯ vitaly -i 4626 layers -p
Product name: "silakka54" id: 4626,
Manufacturer name: "Squalius-cephalus", id: 65261,
Release: 256, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4316856206"
╔══╗╔══╗ ╔══╗╔══╗
╔══╗╔══╗║0 ║║0 ║╔══╗ ╔══╗║5 ║║5 ║╔══╗╔══╗
║0 ║║0 ║║2 ║║3 ║║0 ║╔══╗ ╔══╗║5 ║║3 ║║2 ║║5 ║║5 ║
║0 ║║1 ║╚══╝╚══╝║4 ║║0 ║ ║5 ║║4 ║╚══╝╚══╝║1 ║║0 ║
╚══╝╚══╝╔══╗╔══╗╚══╝║5 ║ ║5 ║╚══╝╔══╗╔══╗╚══╝╚══╝
╔══╗╔══╗║1 ║║1 ║╔══╗╚══╝ ╚══╝╔══╗║6 ║║6 ║╔══╗╔══╗
║1 ║║1 ║║2 ║║3 ║║1 ║╔══╗ ╔══╗║6 ║║3 ║║2 ║║6 ║║6 ║
║0 ║║1 ║╚══╝╚══╝║4 ║║1 ║ ║6 ║║4 ║╚══╝╚══╝║1 ║║0 ║
╚══╝╚══╝╔══╗╔══╗╚══╝║5 ║ ║5 ║╚══╝╔══╗╔══╗╚══╝╚══╝
╔══╗╔══╗║2 ║║2 ║╔══╗╚══╝ ╚══╝╔══╗║7 ║║7 ║╔══╗╔══╗
║2 ║║2 ║║2 ║║3 ║║2 ║╔══╗ ╔══╗║7 ║║3 ║║2 ║║7 ║║7 ║
║0 ║║1 ║╚══╝╚══╝║4 ║║2 ║ ║7 ║║4 ║╚══╝╚══╝║1 ║║0 ║
╚══╝╚══╝╔══╗╔══╗╚══╝║5 ║ ║5 ║╚══╝╔══╗╔══╗╚══╝╚══╝
╔══╗╔══╗║3 ║║3 ║╔══╗╚══╝ ╚══╝╔══╗║8 ║║8 ║╔══╗╔══╗
║3 ║║3 ║║2 ║║3 ║║3 ║╔══╗ ╔══╗║8 ║║3 ║║2 ║║8 ║║8 ║
║0 ║║1 ║╚══╝╚══╝║4 ║║3 ║ ║8 ║║4 ║╚══╝╚══╝║1 ║║0 ║
╚══╝╚══╝ ╚══╝║5 ║ ║5 ║╚══╝ ╚══╝╚══╝
╚══╝ ╚══╝
╔══╗╔══╗ ╔══╗ ╔══╗ ╔══╗╔══╗
║4 ║║4 ║ ║4 ║ ║9 ║ ║9 ║║9 ║
║3 ║║4 ║ ║5 ║ ║5 ║ ║4 ║║3 ║
╚══╝╚══╝ ╚══╝ ╚══╝ ╚══╝╚══╝
```
It also can dump current layer keymap
```
❯ vitaly -i 4626 layers
Product name: "silakka54" id: 4626,
Manufacturer name: "Squalius-cephalus", id: 65261,
Release: 256, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4316856206"
Layer: 0
╔══╗╔══╗ ╔══╗╔══╗
╔══╗╔══╗║2 ║║3 ║╔══╗ ╔══╗║8 ║║9 ║╔══╗╔══╗
║⎋ ║║1 ║║ ║║ ║║4 ║╔══╗ ╔══╗║7 ║║ ║║ ║║0 ║║- ║
║ ║║ ║╚══╝╚══╝║ ║║5 ║ ║6 ║║ ║╚══╝╚══╝║ ║║ ║
╚══╝╚══╝╔══╗╔══╗╚══╝║ ║ ║ ║╚══╝╔══╗╔══╗╚══╝╚══╝
╔══╗╔══╗║W ║║E ║╔══╗╚══╝ ╚══╝╔══╗║I ║║O ║╔══╗╔══╗
║⇥ ║║Q ║║ ║║ ║║R ║╔══╗ ╔══╗║U ║║ ║║ ║║P ║║= ║
║ ║║ ║╚══╝╚══╝║ ║║T ║ ║Y ║║ ║╚══╝╚══╝║ ║║ ║
╚══╝╚══╝╔══╗╔══╗╚══╝║ ║ ║ ║╚══╝╔══╗╔══╗╚══╝╚══╝
╔══╗╔══╗║S ║║D ║╔══╗╚══╝ ╚══╝╔══╗║K ║║L ║╔══╗╔══╗
║MO║║A ║║ ║║ ║║F ║╔══╗ ╔══╗║J ║║ ║║ ║║; ║║' ║
║1 ║║ ║╚══╝╚══╝║ ║║G ║ ║H ║║ ║╚══╝╚══╝║ ║║ ║
╚══╝╚══╝╔══╗╔══╗╚══╝║ ║ ║ ║╚══╝╔══╗╔══╗╚══╝╚══╝
╔══╗╔══╗║X ║║C ║╔══╗╚══╝ ╚══╝╔══╗║, ║║. ║╔══╗╔══╗
║L⇧║║Z ║║ ║║ ║║V ║╔══╗ ╔══╗║M ║║ ║║ ║║/ ║║R⇧║
║ ║║ ║╚══╝╚══╝║ ║║B ║ ║N ║║ ║╚══╝╚══╝║ ║║ ║
╚══╝╚══╝ ╚══╝║ ║ ║ ║╚══╝ ╚══╝╚══╝
╚══╝ ╚══╝
╔══╗╔══╗ ╔══╗ ╔══╗ ╔══╗╔══╗
║L⎈║║L⌥║ ║L⌘║ ║␣ ║ ║⏎ ║║R⌘║
║ ║║ ║ ║ ║ ║ ║ ║ ║║ ║
╚══╝╚══╝ ╚══╝ ╚══╝ ╚══╝╚══╝
```
Layer command accepts --number option which specifies layer number to dump
```
❯ vitaly -i 4626 layers -n 2
Product name: "silakka54" id: 4626,
Manufacturer name: "Squalius-cephalus", id: 65261,
Release: 256, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4316856206"
Layer: 2
╔══╗╔══╗ ╔══╗╔══╗
╔══╗╔══╗║▽ ║║▽ ║╔══╗ ╔══╗║▽ ║║▽ ║╔══╗╔══╗
║▽ ║║▽ ║║ ║║ ║║▽ ║╔══╗ ╔══╗║▽ ║║ ║║ ║║▽ ║║▽ ║
║ ║║ ║╚══╝╚══╝║ ║║▽ ║ ║▽ ║║ ║╚══╝╚══╝║ ║║ ║
╚══╝╚══╝╔══╗╔══╗╚══╝║ ║ ║ ║╚══╝╔══╗╔══╗╚══╝╚══╝
╔══╗╔══╗║▽ ║║▽ ║╔══╗╚══╝ ╚══╝╔══╗║Mo║║⚙↓║╔══╗╔══╗
║▽ ║║▽ ║║ ║║ ║║▽ ║╔══╗ ╔══╗║⚙↑║║↑ ║║ ║║▽ ║║▽ ║
║ ║║ ║╚══╝╚══╝║ ║║▽ ║ ║▽ ║║ ║╚══╝╚══╝║ ║║ ║
╚══╝╚══╝╔══╗╔══╗╚══╝║ ║ ║ ║╚══╝╔══╗╔══╗╚══╝╚══╝
╔══╗╔══╗║▽ ║║▽ ║╔══╗╚══╝ ╚══╝╔══╗║Mo║║Mo║╔══╗╔══╗
║▽ ║║▽ ║║ ║║ ║║▽ ║╔══╗ ╔══╗║Mo║║↓ ║║→ ║║⚙→║║▽ ║
║ ║║ ║╚══╝╚══╝║ ║║▽ ║ ║⚙←║║← ║╚══╝╚══╝║ ║║ ║
╚══╝╚══╝╔══╗╔══╗╚══╝║ ║ ║ ║╚══╝╔══╗╔══╗╚══╝╚══╝
╔══╗╔══╗║▽ ║║▽ ║╔══╗╚══╝ ╚══╝╔══╗║Mo║║▽ ║╔══╗╔══╗
║▽ ║║▽ ║║ ║║ ║║▽ ║╔══╗ ╔══╗║Mo║║5 ║║ ║║▽ ║║▽ ║
║ ║║ ║╚══╝╚══╝║ ║║▽ ║ ║Mo║║4 ║╚══╝╚══╝║ ║║ ║
╚══╝╚══╝ ╚══╝║ ║ ║3 ║╚══╝ ╚══╝╚══╝
╚══╝ ╚══╝
╔══╗╔══╗ ╔══╗ ╔══╗ ╔══╗╔══╗
║▽ ║║▽ ║ ║▽ ║ ║Mo║ ║Mo║║*1║
║ ║║ ║ ║ ║ ║1 ║ ║2 ║║ ║
╚══╝╚══╝ ╚══╝ ╚══╝ ╚══╝╚══╝
*1 - QK_LAYER_LOCK
```
Flag --options/-o allows to override layout options for the dump. Format is `group,variant;group,variant`.
For keyboards with vial protocol support vitaly downloads vial.json file straight from the keyboard.
For via-only keyboards vitaly will try to download keyboard specification from https://github.com/the-via/keyboards/tree/master/src.
If specification of via-only keyboard not published on the-via/keyboards or it doesn't match your firmware repository specification file can be passed with -m option.
```
❯ vitaly -i 611 layers -m k6pro.json
Product name: "Keychron K6 Pro" id: 611,
Manufacturer name: "Keychron", id: 13364,
Release: 256, Serial: "", Path: "DevSrvsID:4316856485"
Layer: 0
╔══╗╔══╗╔══╗╔══╗╔══╗╔══╗╔══╗╔══╗╔══╗╔══╗╔══╗╔══╗╔══╗╔══════╗╔══╗
║⎋ ║║1 ║║2 ║║3 ║║4 ║║5 ║║6 ║║7 ║║8 ║║9 ║║0 ║║- ║║= ║║⌫ ║║*1║
║ ║║ ║║ ║║ ║║ ║║ ║║ ║║ ║║ ║║ ║║ ║║ ║║ ║║ ║║ ║
╚══╝╚══╝╚══╝╚══╝╚══╝╚══╝╚══╝╚══╝╚══╝╚══╝╚══╝╚══╝╚══╝╚══════╝╚══╝
╔════╗╔══╗╔══╗╔══╗╔══╗╔══╗╔══╗╔══╗╔══╗╔══╗╔══╗╔══╗╔══╗╔════╗╔══╗
║⇥ ║║Q ║║W ║║E ║║R ║║T ║║Y ║║U ║║I ║║O ║║P ║║( ║║) ║║\ ║║⇱ ║
║ ║║ ║║ ║║ ║║ ║║ ║║ ║║ ║║ ║║ ║║ ║║ ║║ ║║ ║║ ║
╚════╝╚══╝╚══╝╚══╝╚══╝╚══╝╚══╝╚══╝╚══╝╚══╝╚══╝╚══╝╚══╝╚════╝╚══╝
╔═════╗╔══╗╔══╗╔══╗╔══╗╔══╗╔══╗╔══╗╔══╗╔══╗╔══╗╔══╗╔═══════╗╔══╗
║⇪ ║║A ║║S ║║D ║║F ║║G ║║H ║║J ║║K ║║L ║║; ║║' ║║⏎ ║║⇞ ║
║ ║║ ║║ ║║ ║║ ║║ ║║ ║║ ║║ ║║ ║║ ║║ ║║ ║║ ║
╚═════╝╚══╝╚══╝╚══╝╚══╝╚══╝╚══╝╚══╝╚══╝╚══╝╚══╝╚══╝╚═══════╝╚══╝
╔═══════╗╔══╗╔══╗╔══╗╔══╗╔══╗╔══╗╔══╗╔══╗╔══╗╔══╗╔═════╗╔══╗╔══╗
║L⇧ ║║Z ║║X ║║C ║║V ║║B ║║N ║║M ║║, ║║. ║║/ ║║R⇧ ║║↑ ║║⇟ ║
║ ║║ ║║ ║║ ║║ ║║ ║║ ║║ ║║ ║║ ║║ ║║ ║║ ║║ ║
╚═══════╝╚══╝╚══╝╚══╝╚══╝╚══╝╚══╝╚══╝╚══╝╚══╝╚══╝╚═════╝╚══╝╚══╝
╔═══╗╔═══╗╔═══╗╔═══════════════════════╗╔══╗╔══╗╔══╗╔══╗╔══╗╔══╗
║L⎈ ║║⌨ ║║⌨ ║║␣ ║║⌨ ║║MO║║TG║║← ║║↓ ║║→ ║
║ ║║0 ║║2 ║║ ║║3 ║║2 ║║4 ║║ ║║ ║║ ║
╚═══╝╚═══╝╚═══╝╚═══════════════════════╝╚══╝╚══╝╚══╝╚══╝╚══╝╚══╝
*1 - QK_BACKLIGHT_STEP
```
### Layout subcommand
Layout subcommand allows to list and alter layout options.
```
❯ vitaly -i 4 layout
Product name: "Corne v4" id: 4,
Manufacturer name: "foostan", id: 18003,
Release: 1040, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4294972286"
Current layout options
0) Split Backspace:
0) false <= currently selected
1) true
1) Split Left Shift:
0) false <= currently selected
1) true
2) Split Right Shift:
0) false <= currently selected
1) true
```
To alter layout option use `-o` and `-v` options
### Keys subcommand
Keys subcommand is able to dump and assign signle button to layer and position
Dump
```
❯ vitaly -i 4626 keys -l 0 -p 0,0
Product name: "silakka54" id: 4626,
Manufacturer name: "Squalius-cephalus", id: 65261,
Release: 256, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4316856206"
Key on layer=0, row=0, col=0 => KC_ESCAPE
```
Assign
```
❯ vitaly -i 4626 keys -l 0 -p 0,0 -v KC_COMMA
Product name: "silakka54" id: 4626,
Manufacturer name: "Squalius-cephalus", id: 65261,
Release: 256, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4316856206"
Key on layer=0, row=0, col=0 set to => KC_COMMA, keycode = 0x36
```
Key command accepts all official QMK keycodes listed here together with aliases https://docs.qmk.fm/keycodes_basic .
It is expected to support all the things which are proposed by QMK itself like MO(1), MT(MOD\_LSFT,KC\_2), LSFT(KC\_1) etc...
### Combos subcommand
Combos subcommand is able to dump existing combos and add new combos to buttons
Dump
```
❯ vitaly -i 4626 combos
Product name: "silakka54" id: 4626,
Manufacturer name: "Squalius-cephalus", id: 65261,
Release: 256, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4316856206"
Combos list:
0) KC_E + KC_R = LSFT(KC_9)
1) KC_U + KC_I = LSFT(KC_0)
2) KC_Q + KC_W = LSFT(KC_GRAVE)
3) KC_S + KC_D = MO(4)
4) KC_AUDIO_VOL_DOWN + KC_AUDIO_VOL_UP = KC_AUDIO_MUTE
5) KC_K + KC_L = MO(4)
6) KC_O + KC_P = LSFT(KC_BACKSLASH)
7) KC_A + KC_S = KC_GRAVE
8) KC_W + KC_E = TG(5)
9) KC_D + KC_F = LSFT(KC_LEFT_BRACKET)
10) KC_J + KC_K = LSFT(KC_RIGHT_BRACKET)
11) KC_Z + KC_X = MO(3)
12) KC_L + KC_SEMICOLON = KC_BACKSLASH
13) KC_C + KC_V = KC_LEFT_BRACKET
14) KC_M + KC_COMMA = KC_RIGHT_BRACKET
15) KC_COMMA + KC_DOT = KC_BACKSPACE
16) KC_X + KC_C = MO(2)
17) KC_DOT + KC_SLASH = MO(3)
18) KC_LEFT_SHIFT + KC_RIGHT_SHIFT = QK_CAPS_WORD_TOGGLE
Combo slots 19 - 31 are EMPTY
```
New combo
```
❯ vitaly -i 4626 combos -n 19 -v 'KC_1 + KC_2 = KC_3'
Product name: "silakka54" id: 4626,
Manufacturer name: "Squalius-cephalus", id: 65261,
Release: 256, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4316856206"
Saving combo 19) KC_1 + KC_2 = KC_3
```
Delete combo
```
❯ vitaly -i 4626 combos -n 19 -v ''
Product name: "silakka54" id: 4626,
Manufacturer name: "Squalius-cephalus", id: 65261,
Release: 256, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4316856206"
Saving combo 19) EMPTY
```
### Macros subcommand
Macros subcommand allows to dump and define macroses.
Value format is
```
Text(some text); Tap(KC_1); Down(KC_D); Up(KC_D)
```
Full dump example
```
❯ vitaly -i 4626 macros
Product name: "silakka54" id: 4626,
Manufacturer name: "Squalius-cephalus", id: 65261,
Release: 256, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4317317913"
Macros list:
0) Delay(5); Delay(1000)
1) Text(test)
2) Down(KC_1)
3) Up(KC_1)
4) Tap(KC_1)
5) Text(TEST); Delay(100)
6) Tap(QK_KB_0)
```
Single macro dump example
```
❯ vitaly -i 4626 macros -n 5
Product name: "silakka54" id: 4626,
Manufacturer name: "Squalius-cephalus", id: 65261,
Release: 256, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4317317913"
5) Text(TEST); Delay(100)
```
Define new macro
```
❯ vitaly -i 4626 macros -n 7 -v 'Tap(KC_E); Delay(100); Tap(KC_S)'
Product name: "silakka54" id: 4626,
Manufacturer name: "Squalius-cephalus", id: 65261,
Release: 256, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4317317913"
Updated macros list:
0) Delay(5); Delay(1000)
1) Text(test)
2) Down(KC_1)
3) Up(KC_1)
4) Tap(KC_1)
5) Text(TEST); Delay(100)
6) Tap(QK_KB_0)
7) Tap(KC_E); Delay(100); Tap(KC_S)
Macros successfully updated
```
Delete macro
```
❯ vitaly -i 4626 macros -n 7 -v ''
Product name: "silakka54" id: 4626,
Manufacturer name: "Squalius-cephalus", id: 65261,
Release: 256, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4317317913"
Updated macros list:
0) Delay(5); Delay(1000)
1) Text(test)
2) Down(KC_1)
3) Up(KC_1)
4) Tap(KC_1)
5) Text(TEST); Delay(100)
6) Tap(QK_KB_0)
Macros successfully updated
```
### TapDances command
Tap dances command allows to dump and define tapdances.
Value format is
```
TAP_KEY + HOLD_KEY + DOUBLE_TAP_KEY + TAPHOLD_KEY ~ TAPPING_TERM_MS
```
Define example
```
❯ vitaly -i 4626 tapdances -n 0 -v 'KC_1 + LSFT(KC_1) ~ 30'
Product name: "silakka54" id: 4626,
Manufacturer name: "Squalius-cephalus", id: 65261,
Release: 256, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4316856206"
Saving tap dance 0) On tap: KC_1, On hold: LSFT(KC_1), Tapping term (ms) = 30
```
Dump
```
❯ vitaly -i 4626 tapdances
Product name: "silakka54" id: 4626,
Manufacturer name: "Squalius-cephalus", id: 65261,
Release: 256, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4316856206"
TapDance list:
0) On tap: KC_1, On hold: LSFT(KC_1), Tapping term (ms) = 30
TapDance slots 1 - 31 are EMPTY
```
Undefine tapdance
```
❯ vitaly -i 4626 tapdances -n 0 -v ''
Product name: "silakka54" id: 4626,
Manufacturer name: "Squalius-cephalus", id: 65261,
Release: 256, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4316856206"
Saving tap dance 0) EMPTY
```
### KeyOverrides subcommand
KeyOverrides subcommand is designed to dump and define key overrides
Dump
```
❯ vitaly -i 4626 keyoverrides
Product name: "silakka54" id: 4626,
Manufacturer name: "Squalius-cephalus", id: 65261,
Release: 256, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4316856206"
KeyOverride list:
0) trigger = KC_BACKSPACE; replacement = KC_DELETE; layers = 0;
trigger_mods = MOD_BIT_LSHIFT;
negative_mod_mask = KC_NO;
suppressed_mods = MOD_BIT_LSHIFT;
ko_option_activation_trigger_down = true
ko_option_activation_required_mod_down = false
ko_option_activation_negative_mod_up = false
ko_option_one_mod = false
ko_option_no_reregister_trigger = false
ko_option_no_unregister_on_other_key_down = false
ko_enabled = true
1) EMPTY
...
```
value format is
```
Define key override example
```
❯ vitaly -i 4626 keyoverrides -n 1 -v 'trigger=KC_1; replacement=KC_2; layers=0; trigger_mods=MOD_BIT_LSHIFT; suppressed_mods=MOD_BIT_LSHIFT; options=ko_enabled'
Product name: "silakka54" id: 4626,
Manufacturer name: "Squalius-cephalus", id: 65261,
Release: 256, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4316856206"
Key override 1) trigger = KC_1; replacement = KC_2; layers = 0;
trigger_mods = MOD_BIT_LSHIFT;
negative_mod_mask = KC_NO;
suppressed_mods = MOD_BIT_LSHIFT;
ko_option_activation_trigger_down = false
ko_option_activation_required_mod_down = false
ko_option_activation_negative_mod_up = false
ko_option_one_mod = false
ko_option_no_reregister_trigger = false
ko_option_no_unregister_on_other_key_down = false
ko_enabled = true
Saved
```
Clean key override
```
❯ vitaly -i 4626 keyoverrides -n 1 -v ''
Product name: "silakka54" id: 4626,
Manufacturer name: "Squalius-cephalus", id: 65261,
Release: 256, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4316856206"
Key override 1) EMPTY
Saved
```
### AltRepeats
AltRepeats subcommand allows to dump and define subrepeats
Define alt repleat
```
❯ vitaly -i 4626 altrepeats -n 0 -v 'keycode=KC_1; alt_keycode=KC_2; allowed_mods=MOD_BIT_LSHIFT; options=arep_enabled'
Product name: "silakka54" id: 4626,
Manufacturer name: "Squalius-cephalus", id: 65261,
Release: 256, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4316856206"
Saving altrepeat 0) keycode = KC_1; alt_keycode = KC_2;
allowed_mods = MOD_BIT_LSHIFT;
arep_option_default_to_this_alt_key = false
arep_option_bidirectional = false
arep_option_ignore_mod_handedness = false
arep_enabled = true
```
List defined alt repeats
```
❯ vitaly -i 4626 altrepeats
Product name: "silakka54" id: 4626,
Manufacturer name: "Squalius-cephalus", id: 65261,
Release: 256, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4316856206"
AltRepeat list:
0) keycode = KC_1; alt_keycode = KC_2;
allowed_mods = MOD_BIT_LSHIFT;
arep_option_default_to_this_alt_key = false
arep_option_bidirectional = false
arep_option_ignore_mod_handedness = false
arep_enabled = true
1) EMPTY
...
```
Delete alt repeat
```
❯ vitaly -i 4626 altrepeats -n 0 -v ''
Product name: "silakka54" id: 4626,
Manufacturer name: "Squalius-cephalus", id: 65261,
Release: 256, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4316856206"
Saving altrepeat 0) EMPTY
```
### RGB subcommand
RGB subcommand allows to control RGB effects.
Show info on abilities and current settings
```
❯ vitaly -i 4 rgb -i
Product name: "Corne v4" id: 4,
Manufacturer name: "foostan", id: 18003,
Release: 1040, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4294972286"
RGB verions: 1, max_brightness: 120
supported_effects:
0) Disable
1) Direct Control
2) Solid Color
3) Alphas Mods
4) Gradient Up Down
5) Gradient Left Right
6) Breathing
7) Band Sat
8) Band Val
9) Band Pinwheel Sat
10) Band Pinwheel Val
11) Band Spiral Sat
12) Band Spiral Val
13) Cycle All
14) Cycle Left Right
15) Cycle Up Down
16) Rainbow Moving Chevron
17) Cycle Out In
18) Cycle Out In Dual
19) Cycle Pinwheel
20) Cycle Spiral
21) Dual Beacon
22) Rainbow Beacon
23) Rainbow Pinwheels
24) Raindrops
25) Jellybean Raindrops
26) Hue Breathing
27) Hue Pendulum
28) Hue Wave
29) Typing Heatmap
30) Digital Rain
31) Solid Reactive Simple
32) Solid Reactive
33) Solid Reactive Wide
34) Solid Reactive Multiwide
35) Solid Reactive Cross
36) Solid Reactive Multicross
37) Solid Reactive Nexus
38) Solid Reactive Multinexus
39) Splash
40) Multisplash
41) Solid Splash
42) Solid Multisplash
43) Pixel Rain
44) Pixel Fractal
current settings:
effect: 37 - Solid Reactive Nexus
effect_speed: 200
color_hsv: (h=23, s=204, v=60)
```
Set effect
```
❯ cargo run -- -i 4 rgb -e 25 -i
Product name: "Corne v4" id: 4,
Manufacturer name: "foostan", id: 18003,
Release: 1040, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4294972286"
RGB verions: 1, max_brightness: 120
...
current settings:
effect: 25 - Jellybean Raindrops
effect_speed: 200
color_hsv: (h=23, s=204, v=60)
RGB settings updated...
```
Set effect speed
```
❯ vitaly -i 4 rgb -s 120 -i
Product name: "Corne v4" id: 4,
Manufacturer name: "foostan", id: 18003,
Release: 1040, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4294972286"
RGB verions: 1, max_brightness: 120
...
current settings:
effect: 25 - Jellybean Raindrops
effect_speed: 120
color_hsv: (h=23, s=204, v=60)
RGB settings updated...
```
Set brightness
```
❯ vitaly -i 4 rgb -b 100
Product name: "Corne v4" id: 4,
Manufacturer name: "foostan", id: 18003,
Release: 1040, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4294972286"
RGB settings updated...
```
List supported effects
```
❯ vitaly -i 4 rgb -l
...
```
Direct LED control (only if effect is "Direct Control", usually id 1)
```
❯ vitaly -i 4 rgb -d '0-5=#ffffff;6=#0000ff'
```
Set effect color
```
❯ vitaly -i 4 rgb -i -c '#ffa033'
Product name: "Corne v4" id: 4,
Manufacturer name: "foostan", id: 18003,
Release: 1040, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4294972286"
RGB verions: 1, max_brightness: 120
...
current settings:
effect: 33 - Solid Reactive Wide
effect_speed: 120
color_hsv: (h=23, s=204, v=120)
RGB settings updated...
```
Persist current settings apon restarts
```
❯ cargo run -- -i 4 rgb -i -p
Product name: "Corne v4" id: 4,
Manufacturer name: "foostan", id: 18003,
Release: 1040, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4294972286"
RGB verions: 1, max_brightness: 120
...
current settings:
effect: 33 - Solid Reactive Wide
effect_speed: 120
color_hsv: (h=23, s=204, v=120)
RGB settings persisted...
```
### Save subcommand
Save subcommand dumps current configuration into a file.
```
❯ vitaly -i 4626 save -f silakka54.vil
Product name: "silakka54" id: 4626,
Manufacturer name: "Squalius-cephalus", id: 65261,
Release: 256, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4294972096"
Configutaion saved to file silakka54.vil
```
### Load subcommand
Load subcommans loads keyboard configuration from file.
Flag -p allows to preview content of layout file instead of loading into keyboard.
```
❯ vitaly -i 4626 load -f silakka54.vil
Product name: "silakka54" id: 4626,
Manufacturer name: "Squalius-cephalus", id: 65261,
Release: 256, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4294972096"
Macros restored
Key overrides restored
Alt repeat keys restored
Combos restored
TapDances restored
Keys restored. All done!!!
```
### Encoders subcommand
Encoders subcommand allows to read and write encoders keycodes
Read current value
```
❯ vitaly -i 4 encoders -l 0 -p 1,0
Product name: "Corne v4" id: 4,
Manufacturer name: "foostan", id: 18003,
Release: 1040, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4295189693"
Encoder on layer=0, index=1, direction=0 => QK_UNDERGLOW_HUE_UP
```
Write new value
```
❯ vitaly -i 4 encoders -l 0 -p 1,0 -v KC_1
Product name: "Corne v4" id: 4,
Manufacturer name: "foostan", id: 18003,
Release: 1040, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4295189693"
Encoder on layer=0, index=1, direction=0 set to => KC_1, keycode = 0x1e
```
### Tester subcommand
Tester subcommand allows to test button matrix.
```
❯ vitaly -i 4 tester
Product name: "Corne v4" id: 4,
Manufacturer name: "foostan", id: 18003,
Release: 1040, Serial: "vial:f64c2b3c", Path: "DevSrvsID:4298488908"
Tap buttons. Press Ctrl+c to finish.
╔══╗ ╔══╗
╔══╗║0 ║╔══╗╔══╗ ╔══╗╔══╗║4 ║╔══╗
╔══╗╔══╗║0 ║║3 ║║0 ║║0 ║ ║4 ║║4 ║║3 ║║4 ║╔══╗╔══╗
║0 ║║0 ║║2 ║╚══╝║4 ║║5 ║╔══╗ ╔══╗║5 ║║4 ║╚══╝║2 ║║4 ║║4 ║
║0 ║║1 ║╚══╝╔══╗╚══╝╚══╝║0 ║ ║4 ║╚══╝╚══╝╔══╗╚══╝║1 ║║0 ║
╚══╝╚══╝╔══╗║1 ║╔══╗╔══╗║6 ║ ║6 ║╔══╗╔══╗║5 ║╔══╗╚══╝╚══╝
╔══╗╔══╗║1 ║║3 ║║1 ║║1 ║╚══╝ ╚══╝║5 ║║5 ║║3 ║║5 ║╔══╗╔══╗
║1 ║║1 ║║2 ║╚══╝║4 ║║5 ║╔══╗ ╔══╗║5 ║║4 ║╚══╝║2 ║║5 ║║5 ║
║0 ║║1 ║╚══╝╔══╗╚══╝╚══╝║1 ║ ║5 ║╚══╝╚══╝╔══╗╚══╝║1 ║║0 ║
╚══╝╚══╝╔══╗║2 ║╔══╗╔══╗║6 ║ ║6 ║╔══╗╔══╗║6 ║╔══╗╚══╝╚══╝
╔══╗╔══╗║2 ║║3 ║║2 ║║2 ║╚══╝ ╚══╝║6 ║║6 ║║3 ║║6 ║╔══╗╔══╗
║2 ║║2 ║║2 ║╚══╝║4 ║║5 ║ ║5 ║║4 ║╚══╝║2 ║║6 ║║6 ║
║0 ║║1 ║╚══╝ ╚══╝╚══╝ ╚══╝╚══╝ ╚══╝║1 ║║0 ║
╚══╝╚══╝ ╔══╗ ╔══╗ ╔══╗ ╔══╗ ╔══╗ ╔══╗ ╚══╝╚══╝
║3 ║ ║3 ║ ║3 ║ ║7 ║ ║7 ║ ║7 ║
║3 ║ ║4 ║ ║5 ║ ║5 ║ ║4 ║ ║3 ║
╚══╝ ╚══╝ ╚══╝ ╚══╝ ╚══╝ ╚══╝
```
### Bootload subcommand
Bootload subcommand allows to push keyboard into bootloader mode.