okey-cli 0.1.2

An advanced, easy-to-use key remapper for Linux
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

# yaml-language-server: $schema=https://raw.githubusercontent.com/luckasRanarison/okey/refs/heads/master/schema/okey.json

keyboards:
  - name: "My keyboard"

    keys:
      KEY_X: KEY_Y
      KEY_TAB: KEY_ONELAYER # a custom keycode to activate the layer below

    tap_dances:
      KEY_CAPSLOCK:
        tap: KEY_TAB
        hold: KEY_MOMLAYER
        # timeout: 200

    layers:
      momentary:
        modifier: KEY_MOMLAYER # type is momentary by default, active on hold

        # modifier:
        #   key: KEY_MOMLAYER
        #   type: momentary

        keys:
          KEY_Q: KEY_A
          KEY_H: { unicode: 😂 }
          KEY_D: { shell: 'date "+%d %B %Y"', trim: true }
          KEY_M: [{ env: USERNAME }, { string: "@gmail.com" }] # macros are composable
          KEY_O: [{ press: KEY_O }, { release: KEY_O }, { delay: 500 }, KEY_K]

      one:
        modifier:
          key: KEY_ONELAYER
          type: oneshoot # active for one keypress

        keys:
          KEY_O: KEY_K

      toggle:
        modifier:
          key: KEY_F12
          type: toggle # active until switched off

        keys:
          KEY_O: KEY_K