technofab/pay-respects
1
0
Fork 0
mirror of https://github.com/TECHNOFAB11/pay-respects.git synced 2025-12-12 14:30:10 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
pay-respects/README.md
iff 508e61a451 ci: compile for macOS and Windows
2024-11-18 16:55:24 +01:00

3.5 KiB
Raw Blame History

Pay Respects

Typed a wrong command? Pay Respects will try to correct your wrong console command by simply pressing F!

  • 🚀 Blazing fast suggestion: You won't notice any delay for asking suggestions!
  • ✏️ Easy to write rules: You don't need to know Rust. The rules are written in a TOML file that is simple to work with and can be evaluated to Rust code upon compilation! Optional runtime user defined rules can be enabled starting from 0.5!
  • 🎯 Accurate results: Suggestions must pass several conditions in order to be prompted to the user, no sudo suggestions when you are using doas!
  • 🪶 Tiny binary size: Not even 1MB!

pacman-fix

cd-fix

How to Pay Respects

Please follow the instruction for your shell:

Bash / Zsh / Fish

Manual aliasing:

alias f="$(pay-respects bash)"
alias f="$(pay-respects zsh)"
alias f="$(pay-respects fish)"

Auto aliasing (optional custom alias can be added after --alias argument):

eval "$(pay-respects bash --alias)"
eval "$(pay-respects zsh --alias)"
pay-respects fish --alias | source
Nushell

Add the following output to your configuration file:

pay-respects nushell [--alias <alias>]

Or save it as a file:

pay-respects nushell [--alias <alias>] | save -f ~/.pay-respects.nu

and source from your config file:

source ~/.pay-respects.nu

You can now press F to Pay Respects!

Installing

Install from your package manager if available:

Packaging status

Compiled binaries can be found at GitHub releases.

Generic x86 Desktop Linux
  1. Get the latest binary from releases.
curl -sL -o pay-respects.zip \
$(curl -s https://api.github.com/repos/iffse/pay-respects/releases/latest \
| sed 's/[()",{}]/ /g; s/ /\n/g' \
| grep "https.*pay-respects-ubuntu-latest.zip")
  1. Extract zip, e.g. one of the following:
7z -x pay-respects.zip
unzip pay-respects.zip
  1. System-wide installation:
sudo chmod a+x pay-respects
sudo mv pay-respects /usr/local/bin/pay-respects
  1. Delete the downloaded package:
rm pay-respects.zip
Compile from source (any OS/architecture)

This installation requires you to have Cargo (the Rust package manager) installed.

Install from crates.io, runtime-rules is optional:

cargo install pay-respects --features=runtime-rules

Clone from git and install, suitable for adding custom compile-time rules:

git clone --depth 1 https://github.com/iffse/pay-respects
cd pay-respects
cargo install --path .

Rule Files

See writing rules for how to write rules.

Contributing

Current option to write rules should cover most of the cases.

We need more rule files, contributions are welcomed!

This project is hosted at various sites, choose the one that suits you best: