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

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

keyboards:
  - name: "My keyboard"

    keys:
      # string macros emit raw character keycode and not remap
      KEY_Y: KEY_X
      KEY_U: KEY_I

      KEY_F1: [KEY_H, KEY_E, KEY_L, KEY_L, KEY_O] # executes simple key sequences (press + release)
      KEY_F2: { string: "Hi, you!" } # inserts an ASCII string
      KEY_F3: { env: FOO } # inserts the value of the environment variable
      KEY_F4: { unicode: 🙂👍 } # inserts unicode characters using CTRL + SHIFT + U + <code> + ENTER
      KEY_F5: { shell: "echo 'foo'", trim: true } # inserts shell script output

      KEY_F6: [
          { press: KEY_O },
          { hold: KEY_O },
          { delay: 1000 },
          { release: KEY_O },
          KEY_K, # press + release
        ] # executes detailed key sequences

      KEY_F7: [{ env: USERNAME }, { string: "@gmail.com" }] # all types of macro are composable

      KEY_F8:
        [
          { string: "Hello, " },
          { env: USERNAME },
          { string: "!" },
          { delay: 500 },
          { string: " Today is: " },
          { shell: "date '+%A, %B %d, %Y'", trim: true },
          KEY_ENTER,
        ]