Files
paperclip/docs/start/quickstart.md
Dotta c7c96feef7 docs: simplify quickstart to npx onboard, mention create-adapter skill
- Remove Docker option from quickstart, make `npx paperclipai onboard --yes` the recommended path
- Add tip about `create-agent-adapter` skill in the creating-an-adapter guide

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-04 08:11:06 -06:00

1.1 KiB

title, summary
title summary
Quickstart Get Paperclip running in minutes

Get Paperclip running locally in under 5 minutes.

npx paperclipai onboard --yes

This walks you through setup, configures your environment, and gets Paperclip running.

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 external database required — Paperclip uses an embedded PostgreSQL instance by default.

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:

  1. Create your first company in the web UI
  2. Define a company goal
  3. Create a CEO agent and configure its adapter
  4. Build out the org chart with more agents
  5. Set budgets and assign initial tasks
  6. Hit go — agents start their heartbeats and the company runs
Learn the key concepts behind Paperclip