09d2ef1a37
- Restored docs/ directory that was accidentally deleted by `git add -A` in the v0.2.3 release script - Replaced generic "P" favicon with actual paperclip icon using brand primary color (#2563EB) - Added light/dark logo SVGs for Mintlify navbar (paperclip icon + wordmark) - Updated docs.json with logo configuration for dark/light mode - Fixed release.sh to stage only release-related files instead of `git add -A` to prevent sweeping unrelated changes into release commits 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