Post-Installation Setup

Add boks to PATH

The installer places the boks binary at ~/.local/bin/boks. Add that directory to your PATH if it isn't already there:

# bash
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

# zsh
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc

Verify the installation

boks --help

You should see the boks logo and a list of available flags.

Verify the container runtime

podman --version

On macOS, also make sure the Podman machine is running:

podman machine start

Run your first command

echo '{"ok": true}' | boks jq '.ok'
# true

The first run pulls the image. Subsequent runs start from the local cache.

Next steps

• Quick Start — walk through common usage patterns
• Basic Usage — all flags and options
• Configuration — set up boks.toml