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: about 1 month 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 (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2026-02-02T13:53:03.000Z (4 months ago)
- Last Synced: 2026-02-03T02:54:37.852Z (4 months 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: 564 KB
- Stars: 512
- Watchers: 2
- Forks: 26
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Roadmap: roadmap.md
Awesome Lists containing this project
- awesome-starred - iffse/pay-respects - Command suggestions, command-not-found and thefuck replacement written in Rust (Rust)
- awesome-engineering - pay-respects
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**: Sub-millisecond (<1ms) performance! See
[benchmarks](#benchmarks).
- 🎯 **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 format that gets parsed into Rust code!
- 🦀 **Full Rust capability**: Raw Rust code can be used if TOML rules are not
enough for complex situations!
- 🔩 **Modular**: TOML and Rust 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
> # replace `nu` for `nush` or `nushell` if your executable is named differently
> pay-respects nu --alias []
> ```
> Or save it as a file:
> ```sh
> pay-respects nu --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
> # replace `pwsh` for `powershell` if your executable is named differently
> 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 work:
>
> - `_PR_SHELL`: The binary name of the current working shell
> - `_PR_LAST_COMMAND`: The last command
>
> pay-respects echos back, if applicable, commands that should be evaluated by
> the working shell, such as `cd` commands to change the directory
>
> 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 capture output from multiplexers or 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
You can now **[Press `F` to Pay Respects]**!
[Press `F` to Pay Respects]: https://en.wikipedia.org/wiki/Press_F_to_pay_respects
You will also have a key-binding available on `Ctrl+X` for **experimental
inline mode**, on-the-fly correction with no execution:
- `gitcommit` + `C-X` `C-X` → `git commit`
- `z payrespe` + `C-X` `C-X` → `cd /home/iff/Code/pay-respects`
Integrations with other tools
> - **tmux**, **GNU Screen**, **Zellij**, **WezTerm**, **kitty**:
> - Command log capturing inside the session without the need to rerun commands
> to get error messages. **Requires English locale** (actually `LANG=C`, which
> output is used for matching) to guarantee correct logs.
> - Requires a prompt prefix before your command. Initialization templates
> set it for you automatically.
> - **zoxide**: Uses zoxide's database to navigate through directories.
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. Empty value disables package search
> functionality
> - `_DEF_PR_PACKAGE_MANAGER`: compile-time value
> You can specify different modes to run with `_PR_MODE`:
>
> - `noconfirm`: Execute suggestions without confirm
> - `inline`: Returns best fix with no execution
> - `echo`: Print suggestions to `stdout` without executing
> - `cnf`: Used for command not found hook
>
> Example usage with `noconfirm`:
>
> ```sh
> # new versions
> alias ff="__pr_main noconfirm"
>
> # old versions
> function ff() {
> (
> export _PR_MODE="noconfirm"
> f
> )
> }
> ```
>
> Relating to features:
>
> - `_PR_NO_CONFIG`: Don't load configurations
> - `_PR_NO_DESPERATE`: Disable desperate functions, which are slow but might
> give better results
> - `_PR_PREFIX`: Shell prefix before the command acting as identifier.
> Required for multiplexer command log capturing
> - Disabling integrations:
> - `_PR_NO_ZOXIDE`
> - `_PR_NO_MULTIPLEXER`: Equivalent of turning all the followings:
> - `_PR_NO_TMUX`
> - `_PR_NO_SCREEN`
> - `_PR_NO_ZELLIJ`
> - `_PR_NO_WEZTERM`
> - `_PR_NO_KITTY`
## 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]. Install
scripts are available. For Unix:
```sh
curl -sSfL https://raw.githubusercontent.com/iffse/pay-respects/main/install.sh | sh
```
For Windows, with PowerShell:
```pwsh
irm https://raw.githubusercontent.com/iffse/pay-respects/main/install.ps1 | iex
```
[GitHub releases]: https://github.com/iffse/pay-respects/releases
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
> ```
## Configuration
See [configuration](./config.md).
## Rules & Modules
See the following pages:
- [Writing rules (TOML or Rust)](./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.
You can disable it by setting `_PR_AI_DISABLE`:
```sh
export _PR_AI_DISABLE=1
```
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.
[I don't track nor store
anything.](https://github.com/iffse/pay-respects-serverless)
If it's useful to you, consider making a donation:
[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
rules, contributions are welcomed!
There's also a [roadmap] for contribution opportunities.
[roadmap]: ./roadmap.md
This project is hosted at various sites, you can choose the one that you feel
most comfortable with:
- [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, utils, and select
## Benchmarks
Benchmark script can be executed with `make bench` using `hyperfine`. Here are
the results on my potato computer (AMD Ryzen 5 5600X, DDR4 2400 MHz, HDD 7200
RPM with Btrfs transparent compression, glibc build), you can expect better
results on yours.
| Case | Results |
|---------------------------|---------------------|
| Initialization | 493.7 µs ± 38.1 µs |
| Privilege | 655.0 µs ± 100.4 µs |
| Typo: Command | 5.1 ms ± 0.2 ms |
| Typo: File path | 3.6 ms ± 0.4 ms |
| RegEx: Command | 3.3 ms ± 0.1 ms |
| RegEx: Options | 3.3 ms ± 0.2 ms |
| RegEx: Error | 3.3 ms ± 0.1 ms |
| Desperate: Fuzzy recovery | 703.5 µs ± 65.9 µs |
| Desperate: File look up | 3.4 ms ± 0.2 ms |
Caveats:
- **Integrations are turned off**: In real usage you may feel a delay due to the
execution of `zoxide` itself, for instance, which takes 50ms.
- Binaries are **optimized for size, not speed**, using regex-lite instead of
regex because it's smaller, although slower. A smaller binary helps in
loading times, specially for cold runs.
## Flowchart
Here's a flowchart on how this program works:
