base on Simple hotkey daemon for macOS **skhd** is a simple hotkey daemon for macOS that focuses on responsiveness and performance. Hotkeys are defined in a text file through a simple DSL. **skhd** is able to hotload its config file, meaning that hotkeys can be edited and updated live while **skhd** is running. **skhd** uses a pid-file to make sure that only one instance is running at any moment in time. This also allows for the ability to trigger a manual reload of the config file by invoking `skhd --reload` at any time while an instance of **skhd** is running. The pid-file is saved as `/tmp/skhd_$USER.pid` and so the user that is running **skhd** must have write permission to said path. When running as a service (through launchd) log files can be found at `/tmp/skhd_$USER.out.log` and `/tmp/skhd_$USER.err.log`. list of features | feature | skhd | |:--------------------------:|:----:| | hotload config file | [x] | | hotkey passthrough | [x] | | modal hotkey-system | [x] | | application specific hotkey| [x] | | blacklist applications | [x] | | use media-keys as hotkey | [x] | | synthesize a key-press | [x] | ### Install The first time **skhd** is ran, it will request access to the accessibility API. After access has been granted, the application must be restarted. *Secure Keyboard Entry* must be disabled for **skhd** to receive key-events. **Homebrew**: Requires xcode-8 command-line tools. brew install koekeishiya/formulae/skhd skhd --start-service **Source**: Requires xcode-8 command-line tools. git clone https://github.com/koekeishiya/skhd make install # release version make # debug version ### Usage ``` --install-service: Install launchd service file into ~/Library/LaunchAgents/com.koekeishiya.skhd.plist skhd --install-service --uninstall-service: Remove launchd service file ~/Library/LaunchAgents/com.koekeishiya.skhd.plist skhd --uninstall-service --start-service: Run skhd as a service through launchd skhd --start-service --restart-service: Restart skhd service skhd --restart-service --stop-service: Stop skhd service from running skhd --stop-service -V | --verbose: Output debug information skhd -V -P | --profile: Output profiling information skhd -P -v | --version: Print version number to stdout skhd -v -c | --config: Specify location of config file skhd -c ~/.skhdrc -o | --observe: Output keycode and modifiers of event. Ctrl+C to quit skhd -o -r | --reload: Signal a running instance of skhd to reload its config file skhd -r -h | --no-hotload: Disable system for hotloading config file skhd -h -k | --key: Synthesize a keypress (same syntax as when defining a hotkey) skhd -k "shift + alt - 7" -t | --text: Synthesize a line of text skhd -t "hello, worldシ" ``` ### Configuration The default configuration file is located at one of the following places (in order): - `$XDG_CONFIG_HOME/skhd/skhdrc` - `$HOME/.config/skhd/skhdrc` - `$HOME/.skhdrc` A different location can be specified with the *--config | -c* argument. A sample config is available [here](https://github.com/koekeishiya/skhd/blob/master/examples/skhdrc) A list of all built-in modifier and literal keywords can be found [here](https://github.com/koekeishiya/skhd/issues/1) A hotkey is written according to the following rules: ``` hotkey = <mode> '<' <action> | <action> mode = 'name of mode' | <mode> ',' <mode> action = <keysym> '[' <proc_map_lst> ']' | <keysym> '->' '[' <proc_map_lst> ']' <keysym> ':' <command> | <keysym> '->' ':' <command> <keysym> ';' <mode> | <keysym> '->' ';' <mode> keysym = <mod> '-' <key> | <key> mod = 'modifier keyword' | <mod> '+' <mod> key = <literal> | <keycode> literal = 'single letter or built-in keyword' keycode = 'apple keyboard kVK_<Key> values (0x3C)' proc_map_lst = * <proc_map> proc_map = <string> ':' <command> | <string> '~' | '*' ':' <command> | '*' '~' string = '"' 'sequence of characters' '"' command = command is executed through '$SHELL -c' and follows valid shell syntax. if the $SHELL environment variable is not set, it will default to '/bin/bash'. when bash is used, the ';' delimeter can be specified to chain commands. to allow a command to extend into multiple lines, prepend '\' at the end of the previous line. an EOL character signifies the end of the bind. -> = keypress is not consumed by skhd * = matches every application not specified in <proc_map_lst> ~ = application is unbound and keypress is forwarded per usual, when specified in a <proc_map> ``` A mode is declared according to the following rules: ``` mode_decl = '::' <name> '@' ':' <command> | '::' <name> ':' <command> | '::' <name> '@' | '::' <name> name = desired name for this mode, @ = capture keypresses regardless of being bound to an action command = command is executed through '$SHELL -c' and follows valid shell syntax. if the $SHELL environment variable is not set, it will default to '/bin/bash'. when bash is used, the ';' delimeter can be specified to chain commands. to allow a command to extend into multiple lines, prepend '\' at the end of the previous line. an EOL character signifies the end of the bind. ``` General options that configure the behaviour of **skhd**: ``` # specify a file that should be included as an additional config-file. # treated as an absolutepath if the filename begins with '/' otherwise # the file is relative to the path of the config-file it was loaded from. .load "/Users/Koe/.config/partial_skhdrc" .load "partial_skhdrc" # prevents skhd from monitoring events for listed processes. .blacklist [ "terminal" "qutebrowser" "kitty" "google chrome" ] ``` ", Assign "at most 3 tags" to the expected json: {"id":"5460","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"