🚀 Install

paulrun is a command-line tool, so install it on its own rather than into a project:

uv

uv tool install paulrun

pip

pip install paulrun

Once installed, check it's working:

> paulrun --version
paulrun, version 0.1.0

Requirements

• Python 3.12 or later.
• macOS or Linux. Windows isn't supported.
• bash, which runs shell blocks. It's on macOS and almost every Linux system already.

Optional: shellcheck

If shellcheck is installed, paulrun check uses it to warn about common mistakes in shell blocks, such as an unquoted variable. Without it, shell blocks are still checked for syntax errors.

brew install shellcheck      # macOS
sudo apt install shellcheck  # Debian and Ubuntu

Next steps

• The runbook format to write your first runbook
• The command line to see everything paulrun can do