paperclip-cli Documentation
Full-featured CLI for the Paperclip AI agent orchestration platform. Manage companies, agents, goals, issues, projects, routines, approvals, plugins, heartbeats, and secrets — entirely from the terminal.
Quick Start
# Install
git clone https://github.com/aaron777collins/paperclip-cli.git
cd paperclip-cli && pip install -e .
# Point at your server
paperclip-cli configure --url http://localhost:3100
# Verify connection
paperclip-cli status
# Create a company and hire a CEO
CO=$(paperclip-cli company create --name "AcmeCorp" --json | jq -r '.id')
paperclip-cli agent create --company "$CO" --name "CEO" --role ceo --title "Chief Executive Officer"
Installation
From source (recommended while in development):
git clone https://github.com/aaron777collins/paperclip-cli.git
cd paperclip-cli
pip install -e .
Via pip (when published):
pip install paperclip-cli
Global Flags
These flags work on every command:
| Flag | Description |
|---|---|
--url <url> |
Override server URL for this invocation |
--token <token> |
Override auth token for this invocation |
--json |
Output raw JSON (great for scripting with jq) |
-h / --help |
Show help for any command or subcommand |
Command Reference
| Command group | What it manages |
|---|---|
| configure | Server URL and auth token |
| status | Server health check |
| company | AI companies (isolated orgs) |
| agent | Agents (AI workers) inside a company |
| goal | High-level company objectives |
| issue | Tasks/tickets agents work on |
| project | Containers grouping issues and routines |
| routine | Recurring scheduled/webhook/manual tasks |
| approval | Board approval queue for agent hires |
| plugin | Plugins extending agent capabilities |
| heartbeat | Agent activation history |
| secret | Encrypted agent credentials |
Coverage at a Glance
| Resource | list |
create |
get |
update |
delete |
Extra |
|---|---|---|---|---|---|---|
| company | ✅ | ✅ | ✅ | ✅ | ✅ | — |
| agent | ✅ | ✅ | ✅ | ✅ | ✅ | wakeup |
| goal | ✅ | ✅ | ✅ | ✅ | ✅ | — |
| issue | ✅ | ✅ | ✅ | ✅ | ✅ | — |
| project | ✅ | ✅ | ✅ | ✅ | ✅ | — |
| routine | ✅ | ✅ | ✅ | ✅ | archive¹ |
trigger-add, triggers, runs, run |
| approval | ✅ | — | — | — | — | approve, reject |
| plugin | ✅ | — | — | — | — | examples, install |
| heartbeat | ✅ | — | — | — | — | — |
| secret | ✅ | — | — | — | — | — |
¹ Routines cannot be hard-deleted via the API.
archivesetsstatus=archivedto stop future runs. To fully remove, delete the parent project.
Every command supports --json for machine-readable output and -h/--help for usage.