Skip to content
This repository has been archived by the owner on Feb 15, 2025. It is now read-only.

A Rust-based fast helper to remember, customize and autorun shortcuts or commands for Linux.

License

Notifications You must be signed in to change notification settings

philia897/liz-shortcut-helper

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Liz Shortcut Helper

This project is now archived. Further development will be done in liz-desktop instead. Liz-desktop is developed by Tauri2, with native GUI and shortcut executor.

A Rust-based helper for those who can not remember all the shortcuts (especially those rarely used ones), which supports:

  • Show shortcuts with great filtering function based on Rofi

  • Automatically execute the selected shortcut using ydotool

  • Customize the shortcuts and add whatever shortcut or command you want, see examples in examples.json.

The project name is inspired by a great animation named "Liz and the Blue bird".

Show example

Quick Start

Installation

Download from Release

Download the tar.gz package, and run the install.sh to install and auto configure everything.

tar -xzf [package_name.tar.gz]

cd [package_name]

./install.sh

Building from source

First please make sure rustc and cargo already installed for building this project. For Arch user, you can use sudo pacman -Sy rust to install both.

If you want to further develop or modify the code, recommand to install rustup instead. See this tutorial.

# Clone this project
git clone git@github.com:philia897/liz-shortcut-helper.git

# cd into it and run command to build it:
cd liz-shortcut-helper && cargo build --release

# Run the command to install it:
./scripts/build_package.sh release && cd release && ./install.sh

# Clean up
rm -rf release/ release.tar.gz

If you have problems with ydotool (can not start the service, socket file permission wrong, etc): read this

How to use

# Show all shortcuts by rofi, then autorun the selected shortcut
liz
# or
liz run


# cd to the dir where user can customize the shortcuts following the examples.
cd ~/.config/liz/sheets/
# or cd to the "user_sheets_path" defined in ~/.config/liz/rhythm.toml


# Reload all the sheets inside the given dir, use this when the sheets are modified
liz reload path/to/sheets
liz reload # use default sheets path: /home/{whoami}/.config/liz/sheets

Project Structure

  • Liz: The girl sending command to the daemon for execution, and show the results from Bluebird.

  • Bluebird: The cute blue bird always waiting in the background and responding to the command from Liz.

  • andthe: Define the communication methods between Liz and Bluebird.

Credits & License

  • Thanks to the wonderful projects Rofi and ydotool, which make this project possible.

  • License: GPL-3.0

About

A Rust-based fast helper to remember, customize and autorun shortcuts or commands for Linux.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published