The Potpie CLI (potpie) is how you search, resolve, and record project context. Setup is interactive — run one command in your project and follow the prompts.
Prerequisites
- Python 3.11+ —
python3 --version
- Git — your project should be a Git repo
- pip —
python3 -m pip --version
1. Install
Verify:
If potpie is not found, add your Python scripts directory to PATH (often ~/.local/bin).
2. Run setup
Open a terminal in your project directory:
The wizard walks you through:
- Local config and storage
- Creating your first pot (workspace)
- Optional GitHub login and integrations
- Installing agent skills (Claude, Cursor, etc.)
Setup is idempotent — safe to run again.
3. Verify
You should see a local profile, an active pot, and backend_ready=True.
4. Try it
Manage pots:
Cloud / remote API (optional)
Use this only if you connect to Potpie Cloud or a hosted server — not the default local setup.
Browser login:
API key:
Use the base URL only (no /api/v2 suffix). Example: http://127.0.0.1:8001.
Troubleshooting
potpie: command not found
Pot scope required
Setup feels broken
Log out
Next steps
