2026-03-03 15:49:43 -06:00
---
title: Quickstart
summary: Get Paperclip running in minutes
---
Get Paperclip running locally in under 5 minutes.
2026-03-04 08:11:06 -06:00
## Quick Start (Recommended)
2026-03-03 15:49:43 -06:00
```sh
2026-03-04 08:11:06 -06:00
npx paperclipai onboard --yes
2026-03-03 15:49:43 -06:00
```
2026-03-04 08:11:06 -06:00
This walks you through setup, configures your environment, and gets Paperclip running.
2026-03-03 15:49:43 -06:00
2026-03-28 21:44:15 -05:00
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.
2026-03-20 08:49:46 -05:00
To start Paperclip again later:
```sh
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).
2026-03-04 08:11:06 -06:00
## Local Development
2026-03-03 15:49:43 -06:00
2026-03-20 08:49:46 -05:00
For contributors working on Paperclip itself. Prerequisites: Node.js 20+ and pnpm 9+.
Clone the repository, then:
2026-03-03 15:49:43 -06:00
```sh
pnpm install
pnpm dev
```
This starts the API server and UI at [http://localhost:3100 ](http://localhost:3100 ).
2026-03-04 08:11:06 -06:00
No external database required — Paperclip uses an embedded PostgreSQL instance by default.
2026-03-03 15:49:43 -06:00
2026-03-20 08:49:46 -05:00
When working from the cloned repo, you can also use:
2026-03-03 15:49:43 -06:00
```sh
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
< Card title = "Core Concepts" href = "/start/core-concepts" >
Learn the key concepts behind Paperclip
< / Card >