Karabiner DSL
Lightweight keyremap configuration DSL for Karabiner
Why Karabiner DSL?
Original Karabiner's configuration is very hard to write.
Karabiner DSL is its wrapper, which is easy-to-write and readable.
If you write Karabiner's config with Karabiner DSL, you can update your keyremap configuration quickly.
Installation
First of all, you have to install Karabiner. Karabiner is a keyboard remap utility for Mac OSX.
Then execute:
$ gem install karabiner
Then karabiner
executable will be installed.
This gem provides only karabiner dsl
subcommand and other subcommands are delegated to original CLI for Karabiner.app.
Usage
1. Create ~/.karabiner
item "Command+G to open Google Chrome" do
remap "Cmd-g", to: invoke("Google Chrome")
end
2. Execute karabiner dsl command
$ karabiner dsl
Then karabiner dsl
will update Karabiner's config as you expected.
3. Enable your favorite configurations
Enjoy!
How to write ~/.karabiner
Basics
karabiner-dsl's DSL is a superset of Ruby.
So you can use any Ruby methods in ~/.karabiner.
item
item "configuration unit" do
...
end
In karabiner-dsl, any Karabiner's configuration unit is expressed in item
and its do ~ end
block.
You can group some remap configurations in one item and enable them in one click.
remap
item "remap example" do
remap "Cmd-a", to: "C-a"
end
If you want to add remap configuration, you have to call remap
method.
In this example, Command+A will be remapped to Control+A.
You have to write "key expression" to specify keys to remap.
key expression
a
,A
,1
,;
,tab
,Tab
,space
,up
,down
- any string without
-
will be regarded as single key - ignore upcase or downcase
- any string without
C-a
,Ctrl-a
- regarded as Control + A
C-
is a short expression ofCtrl-
M-a
,Opt-a
- regarded as Option + A
Shift-a
- regarded as large A
- if you write just
A
, it will be regarded as small a
Cmd-a
- regarded as Command + A
Cmd-Shift-a
- regarded as Command + Shift + A
- you can use any combination of Ctrl, Opt, Shift, Cmd
available single keys
a b c ... x y z
0 1 2 ... 7 8 9
F1 F2 ... F11 F12
\ [ ] ; ' ` , . / - =
Up Down Right Left
space tab delete forward_delete capslock
Ctrl_R Ctrl_L
Opt_R Opt_L
Cmd_R Cmd_L
Shift_R Shift_L
Sample
item "Application shortcuts" do
remap "C-o", to: invoke("YoruFukurou") # Invoke the app under the /Applications.
remap "C-u", to: invoke("Google Chrome") # ditto.
remap "C-h", to: invoke("/Users/johndoe/Applications/iTerm.app") # Invoke the app of the specified path.
end
item "Copy date" do
remap "Cmd-d", to: execute("date|pbcopy")
end
item "Control+PNBF to Up/Down/Left/Right" do
remap "C-p", to: "Up"
remap "C-n", to: "Down"
remap "C-b", to: "Left"
remap "C-f", to: "Right"
end
appdef "HIPCHAT", equal: "com.hipchat.HipChat"
item "HipChat Room Change", only: "HIPCHAT" do
remap "Cmd-K", to: "Cmd-Shift-["
remap "Cmd-J", to: "Cmd-Shift-]"
end
item "Window change in the same app" do
remap "Opt-tab", to: "Cmd-F1"
end
Contributing
- Fork it ( https://github.com/k0kubun/karabiner-dsl/fork )
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request