Files
PaperClipAI/docs/start/quickstart.md
T
Harold KimandPaperclip 98df214917 fix: fail closed on unusable Codex auth during sandbox auth merge
When reusing a Codex sandbox, the workspace-restore step now performs
an auth-merge check before adopting the sandbox's auth.json. The merge
fails closed when:

- host or sandbox Codex auth is unusable (missing token or account)
- the subscription payload shapes differ between host and sandbox
- subscription account identities do not match

Additional hardening: node absence on PATH during the embedded decision
script now exits non-zero instead of silently falling through. Co-change
comments link parseAuth (the embedded script) to hasUsableAuthPayload
(codex-home.ts) so a future auth-format change cannot silently diverge
between the two implementations.

Co-Authored-By: Paperclip <noreply@paperclip.ing>
2026-07-09 10:08:57 +00:00

1.6 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.

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, always use npx paperclipai to run commands. The pnpm paperclipai form only works inside a cloned copy of the Paperclip repository (see Local Development below).

Local Development

For contributors working on Paperclip itself. Prerequisites: Node.js 20+ and 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.

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