Pay Respects

Append the following line to your configuration file (--alias no longer required for v0.7+):

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

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

Add the following output to your configuration file:

# replace `nu` for `nush` or `nushell` if your executable is named differently
pay-respects nu --alias [<alias>]

Or save it as a file:

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

and source from your config file:

source ~/.pay-respects.nu

Append the following output to your profile:

# replace `pwsh` for `powershell` if your executable is named differently
pay-respects pwsh --alias [<alias>]

Or directly pipe the output to your profile:

pay-respects pwsh --alias [<alias>] >> $PROFILE

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:

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

• 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.

• _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:

# 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

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

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

Install from crates.io, modules are optional

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:

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