docs/start/quickstart.md at main

0 Fork 0

mirror of https://github.com/paperclipai/docs.git synced 2026-11-07 06:15:59 -10:00

Files

T

Dotta b3704410bd Merge remote-tracking branch 'origin/main' into main

* origin/main:
  docs: fix documentation drift — adapters, plugins, issue documents
  docs: fix logo, simplify quickstart, mention create-adapter skill

# Conflicts:
#	docs.json
#	logo/dark.svg
#	logo/light.svg
#	start/quickstart.md

2026-04-21 14:02:06 -05:00

2.2 KiB

Raw Permalink Blame History

title, summary

title	summary
Quickstart	Get Paperclip running in minutes

Get Paperclip running locally in under 5 minutes.

Quick start (recommended)

The fastest way to get started needs no clone:

npx paperclipai onboard --yes

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

To start Paperclip again later, run:

npx paperclipai run

npx vs pnpm: Use npx paperclipai to run Paperclip as an end user. The pnpm paperclipai command only works inside a cloned copy of the Paperclip source repo. If you get a "Command not found" error, you're probably using pnpm outside the repo. Switch to npx.

Passing API keys

To enable local Claude Code or Codex agent runs, pass your API keys:

ANTHROPIC_API_KEY=sk-... OPENAI_API_KEY=sk-... npx paperclipai run

Docker Compose

No Node.js install needed.

docker compose -f docker-compose.quickstart.yml up --build

Open http://localhost:3100. That's it.

Pass API keys for local adapter runs:

ANTHROPIC_API_KEY=sk-... OPENAI_API_KEY=sk-... \
  docker compose -f docker-compose.quickstart.yml up --build

Local development (contributors)

This section is for contributors working on Paperclip itself. If you just want to use Paperclip, use the Quick Start above.

Prerequisites: Node.js 20+ and pnpm 9+.

git clone https://github.com/nichochar/paperclip.git
cd paperclip
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.

Inside the cloned repo, you can also use the 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

Learn the key concepts behind Paperclip

2.2 KiB Raw Permalink Blame History