Get Paperclip running locally in under 5 minutes. Paperclip quickstart flow If you just want to use Paperclip, start here.
npx paperclipai onboard --yes
This walks you through setup, configures your environment, and gets Paperclip running. If you already have a Paperclip install, rerunning onboard keeps your current config and data paths intact. Use paperclipai configure if you want to edit settings. To start Paperclip again later:
npx paperclipai run
Note: If you used npx for setup, keep using npx paperclipai for day-to-day commands. Use pnpm paperclipai only when you are inside a cloned copy of the Paperclip repository.

Local Development

For contributors working on Paperclip itself. Prerequisites:
  • Node.js 20+
  • pnpm 9+
Clone the repository, then:
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. When working from the cloned repo, you can also use:
pnpm paperclipai run
This auto-onboards if config is missing, runs health checks with auto-repair, and starts the server.

Choose Your Path

If you want to…Use this path
Try Paperclip quicklynpx paperclipai onboard --yes
Develop Paperclip locallypnpm install then pnpm dev
Re-run the CLI from a clonepnpm paperclipai run

What’s Next

Once Paperclip is running, create the minimum company setup:
  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

Core Concepts

Learn the key concepts behind Paperclip

Docs Site Review

See the current docs-site coverage gaps and visual conventions