Quick Start

Paperclip is open source and self-hosted. No Paperclip account required.

Requirements

  • Node.js 20+
  • pnpm 9.15+

Option 1: One-Click Install (Recommended)

$npx paperclipai onboard --yes

This launches interactive setup, guides you through database configuration and first company creation. Uses embedded PostgreSQL by default.

Option 2: Manual Install

1. Clone repository

$git clone https://github.com/paperclipai/paperclip.git
$cd paperclip

2. Install dependencies

$pnpm install

3. Start dev server

$pnpm dev

Server starts at http://localhost:3100. Embedded PostgreSQL created automatically.

Docker Deployment

Using Docker Compose

$curl -O https://github.com/paperclipai/paperclip/releases/latest/download/docker-compose.quickstart.yml
$docker compose up -d

First Use

  1. Open browser at http://localhost:3100
  2. Follow on-screen guide to create your first company
  3. Hire your first AI agents (CEO, CTO, etc.)
  4. Set company goals and budgets
  5. Start running your autonomous company!

Common Commands

CommandDescription
pnpm devFull dev (API + UI, watch mode)
pnpm dev:onceFull dev without file watch
pnpm dev:serverServer only
pnpm buildBuild all packages
pnpm typecheckType checking
pnpm test:runRun tests

Next Steps

πŸ“– Read Official Docs

Check the full documentation on GitHub

πŸ—οΈ Core Concepts

Learn about Paperclip core concepts and architecture