Installation

Requirements

• Python 3.10 or higher

• An AIOBS API key

Install via pip

pip install shepherd-cli

Install via pipx (Recommended)

pipx installs the CLI in an isolated environment:

pipx install shepherd-cli

Install from source

git clone https://github.com/neuralis/shepherd-cli
cd shepherd-cli
pip install -e .

Verify Installation

shepherd --help

You should see:

 Usage: shepherd [OPTIONS] COMMAND [ARGS]...

 🐑 Debug your AI agents like you debug your code

╭─ Options ────────────────────────────────────────────────────────╮
│ --install-completion    Install completion for the current shell │
│ --show-completion       Show completion for the current shell    │
│ --help                  Show this message and exit               │
╰──────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────╮
│ version    Show version information                              │
│ config     Manage configuration                                  │
│ sessions   List and inspect sessions                             │
╰──────────────────────────────────────────────────────────────────╯

Shell Completion

Enable tab completion:

Bash

shepherd –install-completion bash

Zsh

shepherd –install-completion zsh

Fish

shepherd –install-completion fish