https://github.com/iffse/pay-respects
Command suggestions, command-not-found and thefuck replacement written in Rust
https://github.com/iffse/pay-respects
artificial-intelligence bash cli command-line-tool fish nushell powershell productivity quality-of-life rust shell zsh
Last synced: 14 days ago
JSON representation
Command suggestions, command-not-found and thefuck replacement written in Rust
- Host: GitHub
- URL: https://github.com/iffse/pay-respects
- Owner: iffse
- License: agpl-3.0
- Created: 2023-07-30T16:43:42.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-28T15:07:53.000Z (25 days ago)
- Last Synced: 2025-04-01T08:29:18.723Z (21 days ago)
- Topics: artificial-intelligence, bash, cli, command-line-tool, fish, nushell, powershell, productivity, quality-of-life, rust, shell, zsh
- Language: Rust
- Homepage: https://codeberg.org/iff/pay-respects
- Size: 387 KB
- Stars: 209
- Watchers: 2
- Forks: 13
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - iffse/pay-respects - Command suggestions, command-not-found and thefuck replacement written in Rust (Rust)
README
# Pay Respects
Typed a wrong command or don't know what to do? Pay Respects will suggest a fix to your console command by simply pressing `F`!
- ð **Blazing fast suggestion**: You won't notice any delay for asking suggestions!
- ðŊ **Accurate results**: Suggestions are verified before being prompted to the user, no `sudo` suggestions when you are using `doas`!
- âïļ **Easy to write rules**: You don't need to know Rust. The rules are written in a TOML file!
- ðĐ **Modular**: TOML not your taste? Add sources using your favorite language with a custom module!
- ðĪ **AI Support**: AI module comes in aid when there is no rule for your error!
- ðŠķ **Tiny binary size**: Not even 1MB for core features!
## How to Pay Respects
Please follow the instruction for your shell:
Bash / Zsh / Fish
> Append the following line to your configuration file (`--alias` no longer required for v0.7+):
> ```sh
> eval "$(pay-respects bash --alias)"
> eval "$(pay-respects zsh --alias)"
> pay-respects fish --alias | source
> ```
> Arguments:
> - `--alias [alias]`: Alias to a custom key, defaults to `f`
> - `--nocnf`: Disables `command_not_found` handler
> Manual aliasing (**REMOVED** after v0.7):
> ```sh
> alias f="$(pay-respects bash)"
> alias f="$(pay-respects zsh)"
> alias f="$(pay-respects fish)"
> ```
Nushell
> Add the following output to your configuration file:
> ```sh
> pay-respects nushell --alias []
> ```
> Or save it as a file:
> ```sh
> pay-respects nushell --alias [] | save -f ~/.pay-respects.nu
> ```
> and source from your config file:
> ```sh
> source ~/.pay-respects.nu
> ```
PowerShell
> Append the following output to your profile:
> ```pwsh
> pay-respects pwsh --alias []
> ```
> Or directly pipe the output to your profile:
> ```pwsh
> pay-respects pwsh --alias [] >> $PROFILE
> ```
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:
> ```sh
> eval $(_PR_SHELL=sh _PR_LAST_COMMAND="git comit" pay-respects)
> ```
> Following variables are not required, but can be used to reduce unnecessary operations:
>
> - `_PR_ALIAS`: A list of aliases to commands. Separated by newlines with zsh-like formatting, e.g. `gc=git commit`
> - `_PR_ERROR_MSG`: Error message from the previous command. `pay-respects` will rerun previous command to get the error message if absent
> - `_PR_EXECUTABLES`: A space separated list of commands/executables. `pay-respects` will search for `$PATH` if absent
Environment variable configurations
> - `_PR_LIB`: Directory of modules, analogous to `PATH`. If not provided, search in `PATH` or compile-time provided value.
> - `_PR_PACKAGE_MANAGER`: Use defined package manager instead of auto-detecting alphabetically
> You can specify different modes to run with `_PR_MODE`:
>
> - `noconfirm`: Execute suggestions without confirm
> - `echo`: Print suggestions to `stdout` without executing
> - `cnf`: Used for command not found hook
>
> Example usage with `noconfirm`:
>
> ```sh
> function ff() {
> (
> export _PR_MODE="noconfirm"
> f
> )
> }
> ```
You can now **press `F` to Pay Respects**!
## Installing
Install from your package manager if available:
[](https://repology.org/project/pay-respects/versions)
Instructions for package managers
> | OS / Distribution | Repository | Instructions |
> |-------------------|-----------------|---------------------------------------------------|
> | Arch Linux | [AUR] | `paru -S pay-respects` (`-bin`) |
> | Arch Linux (ARM) | [Arch Linux CN] | `sudo pacman -S pay-respects` |
> | MacOS / *Any* | [timescam] | `brew install timescam/homebrew-tap/pay-respects` |
> | NixOS / *Any* | [nixpkgs] | `nix-env -iA nixos.pay-respects` |
[AUR]: https://aur.archlinux.org/
[Arch Linux CN]: https://github.com/archlinuxcn/repo
[nixpkgs]: https://github.com/NixOS/nixpkgs
[timescam]: https://github.com/timescam/homebrew-tap
Alternatively, install pre-built binaries from [GitHub releases](https://github.com/iffse/pay-respects/releases). An [install script](./install.sh) is available:
```sh
curl -sSfL https://raw.githubusercontent.com/iffse/pay-respects/main/install.sh | sh
```
Cargo / Compile from source (any OS/architecture supported by Rust)
> This installation requires you to have Cargo (the Rust package manager) installed.
> Install from [crates.io](https://crates.io/), modules are optional
> ```sh
> cargo install pay-respects
> cargo install pay-respects-module-runtime-rules
> cargo install pay-respects-module-request-ai
> ```
> Clone from git and install, suitable for adding custom compile-time rules:
> ```sh
> git clone --depth 1 https://github.com/iffse/pay-respects
> cd pay-respects
> cargo install --path core
> cargo install --path module-runtime-rules
> cargo install --path module-request-ai
> ```
## Rules & Modules
See the following pages:
- [Writing rules (TOML)](./rules.md)
- [Custom modules](./modules.md)
## AI Integration
> **Disclaimer**: You are using AI generated content on your own risk. Please double-check its suggestions before accepting.
AI suggestions should work out of the box with `request-ai` module installed.
An API key is included with the source (your distribution might have stripped them out). It should always work unless I can no longer afford this public service or rate limits are reached. 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 usages and API configurations](./module-request-ai/README.md)
## Contributing
Current option to write rules should cover most of the cases.
We need more rule files, contributions are welcomed!
Also see [development status](./development.md) for contribution opportunities.
This project is hosted at various sites, choose the one that suits you best:
- [Codeberg](https://codeberg.org/iff/pay-respects)
- [GitHub](https://github.com/iffse/pay-respects)
- [GitLab](https://gitlab.com/iffse/pay-respects)
## Licenses
- **Binaries**: AGPL-3.0
- Core and modules
- **Libraries**: MPL-2.0
- Parser and utils