https://github.com/philia897/liz-desktop
A Rust-based shortcut helper to remember, customize and autorun shortcuts or commands. Developed via Tauri 2.0.
https://github.com/philia897/liz-desktop
enigo rust shortcut tauri2
Last synced: 3 months ago
JSON representation
A Rust-based shortcut helper to remember, customize and autorun shortcuts or commands. Developed via Tauri 2.0.
- Host: GitHub
- URL: https://github.com/philia897/liz-desktop
- Owner: philia897
- License: gpl-3.0
- Created: 2025-02-14T10:47:40.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-11T01:38:21.000Z (about 1 year ago)
- Last Synced: 2025-10-28T04:29:37.530Z (7 months ago)
- Topics: enigo, rust, shortcut, tauri2
- Language: Rust
- Homepage:
- Size: 2.42 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Remember and Execute shortcuts for you
# liz-desktop
[English](./README.md) [中文](./README_zh.md)
A Rust-based shortcut helper to remember, customize and autorun shortcuts or commands. Developed via Tauri 2.0.
- Windows ☑️
- Linux ☑️
- Mac ✘
## Features
- **Fuzzy search:** Search by description, application name or shortcut keys.
- **Auto-execution:** Use [enigo](https://github.com/enigo-rs/enigo) to simulate execution of the selected shortcut.
- **Shortcut/Typing:** Liz supports:
- Shortcut: `ctrl+c`
- Typing a string: `Liz and the Blue Bird`
- Hybrid: `esc [STR]+ Liz and the Blue Bird`
- **Dark/Light mode:** Following the system
- **Dynamic rank:** rank the shortcuts according to the frequency. The most frequently used shortcuts will be on the top.
- **Shortcut manager:** Has a builtin pretty config panel for managing shortcuts
- **Import/Export:** Support importing/exporting the shortcuts via json/txt files.
> You can see an example of **sheet** [here](./data/sheets/examples.json), which denotes the json file that defines a bunch of shortcuts. In the example it shows how to add different types of shortcut commands. In the `data/sheets` you can find other sheets I created and feel free to have a try.
> This [Python script](./scripts/parse_shortcuts.py) can parse Keyboard Shortcuts in [cheatsheets.zip](https://cheatsheets.zip/), extract the shortcuts in the markdown file (click the github icon in the topbar to download the original markdown file), and generate the json file to be imported into Liz.
## Usage
### Installation
Please check the [release](https://github.com/philia897/liz-desktop/releases) and download the packages to install.
> Arch [AUR](https://aur.archlinux.org/packages/liz-desktop-bin): `paru -S liz-desktop-bin`
### Quick Start
- Download shortcut sheet examples [here](./data/sheets/).
- Open the config panel via tray menu `Config`. Right click the table to `Import` the downloaded json sheets.
- Click tray menu `Show` to activate Liz and enjoy.
> You can use a `trigger_shortcut` to `Show` liz as well, the shortcut is `Ctrl+Alt+L` by default.
> The tray menu also have `Persist`, which will persist the data to a .lock file immediately. Liz will auto persist when the program exits.
> Tray menu option `Reload` means reload Liz main view if shortcuts are not added to Liz correctly.
### Configuration
You can control the Liz configuration via any of the following ways:
- (Recommand) Use the builtin Config panel: Click the top-left button and choose `Settings`.
- write your own `rhythm.toml` file following this [example](./data/rhythm.toml) and use it by `liz -c /path/to/your/rhythm.toml`.
- write a `rhythm.toml` file and put it under default `/rhythm.toml`. Liz will automatically use it.
> According to the [doc of enigo](https://github.com/enigo-rs/enigo#), For Linux users you'd better to install these tools for X11 support:
>
> Debian-based: `apt install libxdo-dev`
>
> Arch: `pacman -S xdotool`
>
> Fedora: `dnf install libX11-devel libxdo-devel`
>
> Gentoo: `emerge -a xdotool`
## TroubleShooting
> Please create an issue if encounter any bug or error
In the first run, Liz will create its data dir `liz_path` automatically with the default config path, which will be:
- **Windows:** `%APPDATA%\liz`, such as: `C:\Users\\AppData\Roaming\liz`
- **Linux:** `$HOME/.config/liz`, such as: `/home//.config/liz`
> It can also be customized by setting the environment variable `LIZ_DATA_DIR`.
To reset settings to default, simply delete the file `/rhythm.toml`, or clear the values in the config panel.
## Future plan
- Add Mac support (It theoretically works, but I have not tested it yet. No Mac equipment)
- Using tauri plugins to remember window position and size.
- Using tauri plugin for logging.
- Try SQLite instead of the json lock file for data persistence.
- Find way to reduce the memory cost, (maybe provide a solution to use external tools like [Rofi](https://github.com/davatorium/rofi/))
- ...
## Credits & License
- Thanks to the wonderful projects [Tauri 2.0](https://tauri.app/), [Enigo](https://github.com/enigo-rs/enigo) and [Reference](https://github.com/Fechin/reference/tree/main).
- License: [GPL-3](./LICENSE)