https://github.com/meir/izu

A unified hotkey config based on sxhkd
https://github.com/meir/izu

Last synced: 2 months ago
JSON representation

A unified hotkey config based on sxhkd

• Host: GitHub
• URL: https://github.com/meir/izu
• Owner: meir
• Created: 2024-08-30T13:04:00.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-10-22T08:35:16.000Z (3 months ago)
• Last Synced: 2024-10-23T12:13:24.341Z (3 months ago)
• Language: Go
• Homepage:
• Size: 122 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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](https://github.com/baskerville/sxhkd) and shares part of the config syntax.

## Usage

> !!! This will be reworked once the CLI has been reworked !!!

```

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)

   --string value, -s value     String to parse

   --help, -h                   show help

```

Example:

```

izu --config ./configfile --formatter sway

```

## Supported formatters

 - sxhkd

 - hyprland

 - sway

## Examples

For configuration examples look in `./example/`

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

## License

MIT