PAY_RESPECTS(5)

💅 Creating a Module

okay bestie, welcome to PAY_RESPECTS(5) — the modules manual. There are 2 types of modules, and they are lowkey giving different energy:

• Standard module — will always run to retrieve suggestions
  • Naming convention: _pay-respects-module-<priority>-<your module name>
• Fallback module — will only be run if no previous suggestion were found
  • CAUTION: will immediately return if a suggestion is obtained
  • Naming convention: _pay-respects-fallback-<priority>-<your module name>

Priority is used to retrieve suggestions in a specific order after sorting. Default modules have a priority of 100, periodt ✨

When running your module, you will get the following environment variables:

• _PR_SHELL — user shell
• _PR_COMMAND — the command, without arguments
• _PR_LAST_COMMAND — full command with arguments
• _PR_ERROR_MSG — error message from the command
• _PR_EXECUTABLES — a space ( ) separated list of executables in PATH. Limited to 100k characters, empty if exceeded.

Your module should print:

• To stdout: only suggestions.
  • At the end of each suggestion, append <_PR_BR> so pay-respects knows you are either done or adding another suggestion.
• To stderr: any relevant information that should display to the user (e.g, warning for AI generated content).

An example of a shell based module that always suggest adding a sudo or doas:

#!/bin/sh
echo "sudo $_PR_LAST_COMMAND"
echo "<_PR_BR>"
echo "doas $_PR_LAST_COMMAND"

---

🌈 Adding a Module

Expose your module as executable (chmod u+x) in PATH, and done! slay 🫶

🧚 LIB directories

If exposing modules in PATH annoys you, you can set the _PR_LIB environment variable to specify directories to find the modules, separated by : or ; (analogous to PATH):

Example in a FHS 3.0 compliant system:

# compile-time
export _DEF_PR_LIB="/usr/lib"
# runtime
export _PR_LIB="/usr/lib:$HOME/.local/share"

Example in Windows/DOS compliant systems:

$env:_PR_LIB = @(
  (Join-Path $env:APPDATA "pay-respects" "modules"),
  (Join-Path $env:USERPROFILE ".cargo" "bin")
) -join ';'

---

👀 SEE ALSO

pay-respects-rules(5), pay-respects(1)

💖 AUTHORS

iff. — that's the author, periodt 💅

this page is pay-respects 0.8.8, dated April 2026, and it lives under PAY_RESPECTS(5) — bye bestie, go make a module 🎀