f60c1001ec
Rename all workspace packages from @paperclip/* to @paperclipai/* and the CLI binary from `paperclip` to `paperclipai` in preparation for npm publishing. Bump CLI version to 0.1.0 and add package metadata (description, keywords, license, repository, files). Update all imports, documentation, user-facing messages, and tests accordingly. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1.4 KiB
1.4 KiB
title, summary
| title | summary |
|---|---|
| Quickstart | Get Paperclip running in minutes |
Get Paperclip running locally in under 5 minutes.
Option 1: Docker Compose (Recommended)
The fastest way to start. No Node.js install needed.
docker compose -f docker-compose.quickstart.yml up --build
Open http://localhost:3100. That's it.
The Docker image includes Claude Code CLI and Codex CLI pre-installed for local adapter runs. Pass API keys to enable them:
ANTHROPIC_API_KEY=sk-... OPENAI_API_KEY=sk-... \
docker compose -f docker-compose.quickstart.yml up --build
Option 2: Local Development
Prerequisites: Node.js 20+ and pnpm 9+.
pnpm install
pnpm dev
This starts the API server and UI at http://localhost:3100.
No Docker or external database required — Paperclip uses an embedded PostgreSQL instance by default.
Option 3: One-Command Bootstrap
pnpm paperclipai run
This auto-onboards if config is missing, runs health checks with auto-repair, and starts the server.
What's Next
Once Paperclip is running:
- Create your first company in the web UI
- Define a company goal
- Create a CEO agent and configure its adapter
- Build out the org chart with more agents
- Set budgets and assign initial tasks
- Hit go — agents start their heartbeats and the company runs