diff --git a/cli/README.md b/cli/README.md index 8aa2cc16..8fa213f4 100644 --- a/cli/README.md +++ b/cli/README.md @@ -1,5 +1,5 @@

- Paperclip — runs your business + Paperclip is the app people use to manage AI agents for work.

@@ -7,7 +7,8 @@ Docs · GitHub · Discord · - Twitter + Twitter · + Website

@@ -24,15 +25,15 @@
-## What is Paperclip? +# Paperclip is the app people use to manage AI agents for work. -# Open-source orchestration for zero-human companies +Open-source orchestration for teams of AI agents. -**If OpenClaw is an _employee_, Paperclip is the _company_** +**If OpenClaw is an _employee_, Paperclip is the _company_.** -Paperclip is a Node.js server and React UI that orchestrates a team of AI agents to run a business. Bring your own agents, assign goals, and track your agents' work and costs from one dashboard. +Paperclip is a Node.js server and React UI that orchestrates a team of AI agents to run a business. Bring your own agents, assign goals, and track work and costs from one dashboard. -It looks like a task manager — but under the hood it has org charts, budgets, governance, goal alignment, and agent coordination. +It looks like a task manager. Under the hood: org charts, budgets, governance, goal alignment, and agent coordination. **Manage business goals, not pull requests.** @@ -44,10 +45,6 @@ It looks like a task manager — but under the hood it has org charts, budgets,
-> **COMING SOON: Clipmart** — Download and run entire companies with one click. Browse pre-built company templates — full org structures, agent configs, and skills — and import them into your Paperclip instance in seconds. - -
-

@@ -113,7 +110,7 @@ Every conversation traced. Every decision explained. Full tool-call tracing and

🛡️ Governance

-You're the board. Approve hires, override strategy, pause or terminate any agent — at any time. +Approve hires, override strategy, pause or terminate any agent — at any time.

📊 Org Chart

@@ -157,6 +154,115 @@ Paperclip handles the hard orchestration details correctly.
+## What's Under the Hood + +Paperclip is a full control plane, not a wrapper. Before you build any of this yourself, know that it already exists: + +``` +┌──────────────────────────────────────────────────────────────┐ +│ PAPERCLIP SERVER │ +│ │ +│ ┌───────────┐ ┌───────────┐ ┌───────────┐ ┌───────────┐ │ +│ │Identity & │ │ Work & │ │ Heartbeat │ │Governance │ │ +│ │ Access │ │ Tasks │ │ Execution │ │& Approvals│ │ +│ └───────────┘ └───────────┘ └───────────┘ └───────────┘ │ +│ │ +│ ┌───────────┐ ┌───────────┐ ┌───────────┐ ┌───────────┐ │ +│ │ Org Chart │ │Workspaces │ │ Plugins │ │ Budget │ │ +│ │ & Agents │ │ & Runtime │ │ │ │ & Costs │ │ +│ └───────────┘ └───────────┘ └───────────┘ └───────────┘ │ +│ │ +│ ┌───────────┐ ┌───────────┐ ┌───────────┐ ┌───────────┐ │ +│ │ Routines │ │ Secrets & │ │ Activity │ │ Company │ │ +│ │& Schedules│ │ Storage │ │ & Events │ │Portability│ │ +│ └───────────┘ └───────────┘ └───────────┘ └───────────┘ │ +└──────────────────────────────────────────────────────────────┘ + ▲ ▲ ▲ ▲ + ┌─────┴─────┐ ┌─────┴─────┐ ┌─────┴─────┐ ┌─────┴─────┐ + │ Claude │ │ Codex │ │ CLI │ │ HTTP/web │ + │ Code │ │ │ │ agents │ │ bots │ + └───────────┘ └───────────┘ └───────────┘ └───────────┘ +``` + +### The Systems + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +**Identity & Access** — Two deployment modes (trusted local or authenticated), board users, agent API keys, short-lived run JWTs, company memberships, invite flows, and OpenClaw onboarding. Every mutating request is traced to an actor. + + + +**Org Chart & Agents** — Agents have roles, titles, reporting lines, permissions, and budgets. Adapter examples match the diagram: Claude Code, Codex, CLI agents such as Cursor/Gemini/bash, HTTP/webhook bots such as OpenClaw, and external adapter plugins. If it can receive a heartbeat, it's hired. + +
+ +**Work & Task System** — Issues carry company/project/goal/parent links, atomic checkout with execution locks, first-class blocker dependencies, comments, documents, attachments, work products, labels, and inbox state. No double-work, no lost context. + + + +**Heartbeat Execution** — DB-backed wakeup queue with coalescing, budget checks, workspace resolution, secret injection, skill loading, and adapter invocation. Runs produce structured logs, cost events, session state, and audit trails. Recovery handles orphaned runs automatically. + +
+ +**Workspaces & Runtime** — Project workspaces, isolated execution workspaces (git worktrees, operator branches), and runtime services (dev servers, preview URLs). Agents work in the right directory with the right context every time. + + + +**Governance & Approvals** — Board approval workflows, execution policies with review/approval stages, decision tracking, budget hard-stops, agent pause/resume/terminate, and full audit logging. Nothing ships without your sign-off. + +
+ +**Budget & Cost Control** — Token and cost tracking by company, agent, project, goal, issue, provider, and model. Scoped budget policies with warning thresholds and hard stops. Overspend pauses agents and cancels queued work automatically. + + + +**Routines & Schedules** — Recurring tasks with cron, webhook, and API triggers. Concurrency and catch-up policies. Each routine execution creates a tracked issue and wakes the assigned agent — no manual kick-offs needed. + +
+ +**Plugins** — Instance-wide plugin system with out-of-process workers, capability-gated host services, job scheduling, tool exposure, and UI contributions. Extend Paperclip without forking it. + + + +**Secrets & Storage** — Instance and company secrets, encrypted local storage, provider-backed object storage, attachments, and work products. Sensitive values stay out of prompts unless a scoped run explicitly needs them. + +
+ +**Activity & Events** — Mutating actions, heartbeat state changes, cost events, approvals, comments, and work products are recorded as durable activity so operators can audit what happened and why. + + + +**Company Portability** — Export and import entire organizations — agents, skills, projects, routines, and issues — with secret scrubbing and collision handling. One deployment, many companies, complete data isolation. + +
+ +
+ ## What Paperclip is not | | | @@ -208,7 +314,7 @@ This starts the API server at `http://localhost:3100`. An embedded PostgreSQL da **What does a typical setup look like?** Locally, a single Node.js process manages an embedded Postgres and local file storage. For production, point it at your own Postgres and deploy however you like. Configure projects, agents, and goals — the agents take care of the rest. -If you're a solo-entreprenuer you can use Tailscale to access Paperclip on the go. Then later you can deploy to e.g. Vercel when you need it. +If you're a solo entrepreneur you can use Tailscale to access Paperclip on the go. Then later you can deploy to e.g. Vercel when you need it. **Can I run multiple companies?** Yes. A single deployment can run an unlimited number of companies with complete data isolation. @@ -271,20 +377,42 @@ See [doc/DEVELOPING.md](https://github.com/paperclipai/paperclip/blob/master/doc - ✅ Skills Manager - ✅ Scheduled Routines - ✅ Better Budgeting -- ⚪ Artifacts & Deployments -- ⚪ CEO Chat -- ⚪ MAXIMIZER MODE +- ✅ Agent Reviews and Approvals - ✅ Multiple Human Users - ⚪ Cloud / Sandbox agents (e.g. Cursor / e2b agents) +- ⚪ Artifacts & Work Products +- ⚪ Memory / Knowledge +- ⚪ Enforced Outcomes +- ⚪ MAXIMIZER MODE +- ⚪ Deep Planning +- ⚪ Work Queues +- ⚪ Self-Organization +- ⚪ Automatic Organizational Learning +- ⚪ CEO Chat - ⚪ Cloud deployments - ⚪ Desktop App +This is the short roadmap preview. See the full roadmap in [ROADMAP.md](https://github.com/paperclipai/paperclip/blob/master/ROADMAP.md). +
## Community & Plugins Find Plugins and more at [awesome-paperclip](https://github.com/gsxdsm/awesome-paperclip) +## Telemetry + +Paperclip collects anonymous usage telemetry to help us understand how the product is used and improve it. No personal information, issue content, prompts, file paths, or secrets are ever collected. Private repository references are hashed with a per-install salt before being sent. + +Telemetry is **enabled by default** and can be disabled with any of the following: + +| Method | How | +| -------------------- | ------------------------------------------------------- | +| Environment variable | `PAPERCLIP_TELEMETRY_DISABLED=1` | +| Standard convention | `DO_NOT_TRACK=1` | +| CI environments | Automatically disabled when `CI=true` | +| Config file | Set `telemetry.enabled: false` in your Paperclip config | + ## Contributing We welcome contributions. See the [contributing guide](https://github.com/paperclipai/paperclip/blob/master/CONTRIBUTING.md) for details. @@ -302,7 +430,7 @@ We welcome contributions. See the [contributing guide](https://github.com/paperc ## License -MIT © 2026 Paperclip +MIT © 2026 [Paperclip Labs, Inc](https://paperclip.ing) ## Star History @@ -313,9 +441,5 @@ MIT © 2026 Paperclip ---

- -

- -

- Open source under MIT. Built for people who want to run companies, not babysit agents. + Open source under MIT. Built for people who want to get work done, not babysit agents.

diff --git a/cli/src/utils/banner.ts b/cli/src/utils/banner.ts index 16d3a987..9c0fdc70 100644 --- a/cli/src/utils/banner.ts +++ b/cli/src/utils/banner.ts @@ -9,7 +9,7 @@ const PAPERCLIP_ART = [ "╚═╝ ╚═╝ ╚═╝╚═╝ ╚══════╝╚═╝ ╚═╝ ╚═════╝╚══════╝╚═╝╚═╝ ", ] as const; -const TAGLINE = "Open-source orchestration for zero-human companies"; +const TAGLINE = "The app people use to manage AI agents for work"; export function printPaperclipCliBanner(): void { const lines = [