pay-respects/README.md

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!
• 🤖 AI Support: AI comes in aid when there is no rule for your error!
• 🪶 Tiny binary size: Not even 1MB!

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

Custom initialization for arbitrary shell

pay-respects only requires 2 environment variables to function:

• _PR_SHELL: The binary name of the current working shell.
• _PR_LAST_COMMAND: The last command.

pay-respects echos back, if applicable, a cd command that can be evaluated by the current working shell.

General example:

eval $(_PR_SHELL=sh _PR_LAST_COMMAND="git comit" pay-respects)

You can now press F to Pay Respects!

Installing

Install from your package manager if available:

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")

2. Extract zip, e.g. one of the following:

7z -x pay-respects.zip
unzip pay-respects.zip

3. System-wide installation:

sudo chmod a+x pay-respects
sudo mv pay-respects /usr/local/bin/pay-respects

4. 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, features are optional

cargo install pay-respects --features=runtime-rules,request-ai

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.

AI Integration

AI suggestions should work out of the box unless rate limit has reached. Bring your own API keys to avoid it.

If it's useful to you, please share this project and spread the word. Also consider making a donation to keep its public usage alive:

AI and API Configuration

Configuration is done via environment variables:

• _PR_AI_API_KEY: You own API key
• _PR_AI_URL: URL used. Defaults to https://api.groq.com/openai/v1/chat/completions
• _PR_AI_MODEL: Model used. Defaults to llama3-8b-8192

Compile time variables:

• _DEF_PR_AI_API_KEY: Default API key, included in compile-time

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:

• Codeberg
• GitHub
• GitLab