Skip to content

README.md

Latest commit

 

History

History
83 lines (65 loc) · 2.09 KB

README.md

File metadata and controls

83 lines (65 loc) · 2.09 KB

izu

izu is a unified hotkey config that's made to parse its own config and generate it into any other hotkey config available.

This can thus be used to manage multiple hotkey daemons on different hosts.

The primary reason for this is switching display protocols or window managers on Linux (using NixOS managed config files).

It's inspired by sxhkd and shares part of the config syntax.

Usage

NAME:
   izu - A unified hotkey config based on sxhkd.

USAGE:
   izu [global options] command [command options]

COMMANDS:
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --config value, -c value     Path to the configuration file
   --formatter value, -f value  Path to the formatter lua file
   --version, -v                Print the version (default: false)
   --verbose, -V                Print verbose output (default: false)
   --silent, -S                 Silent output, does not output any logs or errors unless when panicking (default: false)
   --string value, -s value     String to parse
   --help, -h                   show help

Example:

izu --config ./configfile --formatter sway

Supported formatters

  • sxhkd (done)
  • hyprland (needs improvement)
  • sway (needs improvement)

Examples

For configuration examples look in ./example/

For formatter examples look in ./pkg/izu/formatters/

NixOS Example

In your flake.nix:

{
    inputs = {
        # ...
        izu.url = "github:meir/izu";
    };

}

As a new overlay add the following:

(final: prev: {
    izu = izu.packages."${final.system}";
    izuGenerate = izu.packages."${final.system}".izuGenerate;
})

Then generate your config my overriding the package with your variables like so:

home.file.".config/sxhkd/sxhkdrc".source = pkgs.izuGenerate.override {
    formatter = "sxhkd";
    hotkeys = [
        ''
            super + {_,shift +} space
                rofi -show {drun,run} &
        ''
    ];
};

To insert it within an existing file, you'll have to use readFile in order to gain the generated content.

License

MIT