paperclipai 0.1.2 → 0.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +272 -0
- package/dist/index.js +14 -40
- package/dist/index.js.map +2 -2
- package/package.json +3 -15
package/README.md
ADDED
|
@@ -0,0 +1,272 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="doc/assets/header.png" alt="Paperclip — runs your business" width="720" />
|
|
3
|
+
</p>
|
|
4
|
+
|
|
5
|
+
<p align="center">
|
|
6
|
+
<a href="#quickstart"><strong>Quickstart</strong></a> ·
|
|
7
|
+
<a href="https://paperclip.dev/docs"><strong>Docs</strong></a> ·
|
|
8
|
+
<a href="https://github.com/paperclipai/paperclip"><strong>GitHub</strong></a> ·
|
|
9
|
+
<a href="https://discord.gg/paperclip"><strong>Discord</strong></a>
|
|
10
|
+
</p>
|
|
11
|
+
|
|
12
|
+
<p align="center">
|
|
13
|
+
<a href="https://github.com/paperclipai/paperclip/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue" alt="MIT License" /></a>
|
|
14
|
+
<a href="https://github.com/paperclipai/paperclip/stargazers"><img src="https://img.shields.io/github/stars/paperclipai/paperclip?style=flat" alt="Stars" /></a>
|
|
15
|
+
<a href="https://discord.gg/paperclip"><img src="https://img.shields.io/discord/000000000?label=discord" alt="Discord" /></a>
|
|
16
|
+
</p>
|
|
17
|
+
|
|
18
|
+
<br/>
|
|
19
|
+
|
|
20
|
+
<div align="center">
|
|
21
|
+
<video src="https://github.com/user-attachments/assets/773bdfb2-6d1e-4e30-8c5f-3487d5b70c8f" width="600" controls></video>
|
|
22
|
+
</div>
|
|
23
|
+
|
|
24
|
+
<br/>
|
|
25
|
+
|
|
26
|
+
## What is Paperclip?
|
|
27
|
+
|
|
28
|
+
# Open-source orchestration for zero-human companies
|
|
29
|
+
|
|
30
|
+
**If OpenClaw is an _employee_, Paperclip is the _company_**
|
|
31
|
+
|
|
32
|
+
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.
|
|
33
|
+
|
|
34
|
+
It looks like a task manager — but under the hood it has org charts, budgets, governance, goal alignment, and agent coordination.
|
|
35
|
+
|
|
36
|
+
**Manage business goals, not pull requests.**
|
|
37
|
+
|
|
38
|
+
| | Step | Example |
|
|
39
|
+
| ------ | --------------- | ------------------------------------------------------------------ |
|
|
40
|
+
| **01** | Define the goal | _"Build the #1 AI note-taking app to $1M MRR."_ |
|
|
41
|
+
| **02** | Hire the team | CEO, CTO, engineers, designers, marketers — any bot, any provider. |
|
|
42
|
+
| **03** | Approve and run | Review strategy. Set budgets. Hit go. Monitor from the dashboard. |
|
|
43
|
+
|
|
44
|
+
<br/>
|
|
45
|
+
|
|
46
|
+
> **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.
|
|
47
|
+
|
|
48
|
+
<br/>
|
|
49
|
+
|
|
50
|
+
<div align="center">
|
|
51
|
+
<table>
|
|
52
|
+
<tr>
|
|
53
|
+
<td align="center"><strong>Works<br/>with</strong></td>
|
|
54
|
+
<td align="center"><img src="doc/assets/logos/openclaw.svg" width="32" alt="OpenClaw" /><br/><sub>OpenClaw</sub></td>
|
|
55
|
+
<td align="center"><img src="doc/assets/logos/claude.svg" width="32" alt="Claude" /><br/><sub>Claude Code</sub></td>
|
|
56
|
+
<td align="center"><img src="doc/assets/logos/codex.svg" width="32" alt="Codex" /><br/><sub>Codex</sub></td>
|
|
57
|
+
<td align="center"><img src="doc/assets/logos/cursor.svg" width="32" alt="Cursor" /><br/><sub>Cursor</sub></td>
|
|
58
|
+
<td align="center"><img src="doc/assets/logos/bash.svg" width="32" alt="Bash" /><br/><sub>Bash</sub></td>
|
|
59
|
+
<td align="center"><img src="doc/assets/logos/http.svg" width="32" alt="HTTP" /><br/><sub>HTTP</sub></td>
|
|
60
|
+
</tr>
|
|
61
|
+
</table>
|
|
62
|
+
|
|
63
|
+
<em>If it can receive a heartbeat, it's hired.</em>
|
|
64
|
+
|
|
65
|
+
</div>
|
|
66
|
+
|
|
67
|
+
<br/>
|
|
68
|
+
|
|
69
|
+
## Paperclip is right for you if
|
|
70
|
+
|
|
71
|
+
- ✅ You want to build **autonomous AI companies**
|
|
72
|
+
- ✅ You **coordinate many different agents** (OpenClaw, Codex, Claude, Cursor) toward a common goal
|
|
73
|
+
- ✅ You have **20 simultaneous Claude Code terminals** open and lose track of what everyone is doing
|
|
74
|
+
- ✅ You want agents running **autonomously 24/7**, but still want to audit work and chime in when needed
|
|
75
|
+
- ✅ You want to **monitor costs** and enforce budgets
|
|
76
|
+
- ✅ You want a process for managing agents that **feels like using a task manager**
|
|
77
|
+
- ✅ You want to manage your autonomous businesses **from your phone**
|
|
78
|
+
|
|
79
|
+
<br/>
|
|
80
|
+
|
|
81
|
+
## Features
|
|
82
|
+
|
|
83
|
+
<table>
|
|
84
|
+
<tr>
|
|
85
|
+
<td align="center" width="33%">
|
|
86
|
+
<h3>🔌 Bring Your Own Agent</h3>
|
|
87
|
+
Any agent, any runtime, one org chart. If it can receive a heartbeat, it's hired.
|
|
88
|
+
</td>
|
|
89
|
+
<td align="center" width="33%">
|
|
90
|
+
<h3>🎯 Goal Alignment</h3>
|
|
91
|
+
Every task traces back to the company mission. Agents know <em>what</em> to do and <em>why</em>.
|
|
92
|
+
</td>
|
|
93
|
+
<td align="center" width="33%">
|
|
94
|
+
<h3>💓 Heartbeats</h3>
|
|
95
|
+
Agents wake on a schedule, check work, and act. Delegation flows up and down the org chart.
|
|
96
|
+
</td>
|
|
97
|
+
</tr>
|
|
98
|
+
<tr>
|
|
99
|
+
<td align="center">
|
|
100
|
+
<h3>💰 Cost Control</h3>
|
|
101
|
+
Monthly budgets per agent. When they hit the limit, they stop. No runaway costs.
|
|
102
|
+
</td>
|
|
103
|
+
<td align="center">
|
|
104
|
+
<h3>🏢 Multi-Company</h3>
|
|
105
|
+
One deployment, many companies. Complete data isolation. One control plane for your portfolio.
|
|
106
|
+
</td>
|
|
107
|
+
<td align="center">
|
|
108
|
+
<h3>🎫 Ticket System</h3>
|
|
109
|
+
Every conversation traced. Every decision explained. Full tool-call tracing and immutable audit log.
|
|
110
|
+
</td>
|
|
111
|
+
</tr>
|
|
112
|
+
<tr>
|
|
113
|
+
<td align="center">
|
|
114
|
+
<h3>🛡️ Governance</h3>
|
|
115
|
+
You're the board. Approve hires, override strategy, pause or terminate any agent — at any time.
|
|
116
|
+
</td>
|
|
117
|
+
<td align="center">
|
|
118
|
+
<h3>📊 Org Chart</h3>
|
|
119
|
+
Hierarchies, roles, reporting lines. Your agents have a boss, a title, and a job description.
|
|
120
|
+
</td>
|
|
121
|
+
<td align="center">
|
|
122
|
+
<h3>📱 Mobile Ready</h3>
|
|
123
|
+
Monitor and manage your autonomous businesses from anywhere.
|
|
124
|
+
</td>
|
|
125
|
+
</tr>
|
|
126
|
+
</table>
|
|
127
|
+
|
|
128
|
+
<br/>
|
|
129
|
+
|
|
130
|
+
## Problems Paperclip solves
|
|
131
|
+
|
|
132
|
+
| Without Paperclip | With Paperclip |
|
|
133
|
+
| ------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
|
|
134
|
+
| ❌ You have 20 Claude Code tabs open and can't track which one does what. On reboot you lose everything. | ✅ Tasks are ticket-based, conversations are threaded, sessions persist across reboots. |
|
|
135
|
+
| ❌ You manually gather context from several places to remind your bot what you're actually doing. | ✅ Context flows from the task up through the project and company goals — your agent always knows what to do and why. |
|
|
136
|
+
| ❌ Folders of agent configs are disorganized and you're re-inventing task management, communication, and coordination between agents. | ✅ Paperclip gives you org charts, ticketing, delegation, and governance out of the box — so you run a company, not a pile of scripts. |
|
|
137
|
+
| ❌ Runaway loops waste hundreds of dollars of tokens and max your quota before you even know what happened. | ✅ Cost tracking surfaces token budgets and throttles agents when they're out. Management prioritizes with budgets. |
|
|
138
|
+
| ❌ You have recurring jobs (customer support, social, reports) and have to remember to manually kick them off. | ✅ Heartbeats handle regular work on a schedule. Management supervises. |
|
|
139
|
+
| ❌ You have an idea, you have to find your repo, fire up Claude Code, keep a tab open, and babysit it. | ✅ Add a task in Paperclip. Your coding agent works on it until it's done. Management reviews their work. |
|
|
140
|
+
|
|
141
|
+
<br/>
|
|
142
|
+
|
|
143
|
+
## Why Paperclip is special
|
|
144
|
+
|
|
145
|
+
Paperclip handles the hard orchestration details correctly.
|
|
146
|
+
|
|
147
|
+
| | |
|
|
148
|
+
| --------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
|
149
|
+
| **Atomic execution.** | Task checkout and budget enforcement are atomic, so no double-work and no runaway spend. |
|
|
150
|
+
| **Persistent agent state.** | Agents resume the same task context across heartbeats instead of restarting from scratch. |
|
|
151
|
+
| **Runtime skill injection.** | Agents can learn Paperclip workflows and project context at runtime, without retraining. |
|
|
152
|
+
| **Governance with rollback.** | Approval gates are enforced, config changes are revisioned, and bad changes can be rolled back safely. |
|
|
153
|
+
| **Goal-aware execution.** | Tasks carry full goal ancestry so agents consistently see the "why," not just a title. |
|
|
154
|
+
| **Portable company templates.** | Export/import orgs, agents, and skills with secret scrubbing and collision handling. |
|
|
155
|
+
| **True multi-company isolation.** | Every entity is company-scoped, so one deployment can run many companies with separate data and audit trails. |
|
|
156
|
+
|
|
157
|
+
<br/>
|
|
158
|
+
|
|
159
|
+
## What Paperclip is not
|
|
160
|
+
|
|
161
|
+
| | |
|
|
162
|
+
| ---------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
|
163
|
+
| **Not a chatbot.** | Agents have jobs, not chat windows. |
|
|
164
|
+
| **Not an agent framework.** | We don't tell you how to build agents. We tell you how to run a company made of them. |
|
|
165
|
+
| **Not a workflow builder.** | No drag-and-drop pipelines. Paperclip models companies — with org charts, goals, budgets, and governance. |
|
|
166
|
+
| **Not a prompt manager.** | Agents bring their own prompts, models, and runtimes. Paperclip manages the organization they work in. |
|
|
167
|
+
| **Not a single-agent tool.** | This is for teams. If you have one agent, you probably don't need Paperclip. If you have twenty — you definitely do. |
|
|
168
|
+
| **Not a code review tool.** | Paperclip orchestrates work, not pull requests. Bring your own review process. |
|
|
169
|
+
|
|
170
|
+
<br/>
|
|
171
|
+
|
|
172
|
+
## Quickstart
|
|
173
|
+
|
|
174
|
+
Open source. Self-hosted. No Paperclip account required.
|
|
175
|
+
|
|
176
|
+
```bash
|
|
177
|
+
npx paperclipai onboard
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
Or manually:
|
|
181
|
+
|
|
182
|
+
```bash
|
|
183
|
+
git clone https://github.com/paperclipai/paperclip.git
|
|
184
|
+
cd paperclip
|
|
185
|
+
pnpm install
|
|
186
|
+
pnpm dev
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
This starts the API server at `http://localhost:3100`. An embedded PostgreSQL database is created automatically — no setup required.
|
|
190
|
+
|
|
191
|
+
> **Requirements:** Node.js 20+, pnpm 9.15+
|
|
192
|
+
|
|
193
|
+
<br/>
|
|
194
|
+
|
|
195
|
+
## FAQ
|
|
196
|
+
|
|
197
|
+
**What does a typical setup look like?**
|
|
198
|
+
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.
|
|
199
|
+
|
|
200
|
+
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.
|
|
201
|
+
|
|
202
|
+
**Can I run multiple companies?**
|
|
203
|
+
Yes. A single deployment can run an unlimited number of companies with complete data isolation.
|
|
204
|
+
|
|
205
|
+
**How is Paperclip different from agents like OpenClaw or Claude Code?**
|
|
206
|
+
Paperclip _uses_ those agents. It orchestrates them into a company — with org charts, budgets, goals, governance, and accountability.
|
|
207
|
+
|
|
208
|
+
**Why should I use Paperclip instead of just pointing my OpenClaw to Asana or Trello?**
|
|
209
|
+
Agent orchestration has subtleties in how you coordinate who has work checked out, how to maintain sessions, monitoring costs, establishing governance - Paperclip does this for you.
|
|
210
|
+
|
|
211
|
+
(Bring-your-own-ticket-system is on the Roadmap)
|
|
212
|
+
|
|
213
|
+
**Do agents run continuously?**
|
|
214
|
+
By default, agents run on scheduled heartbeats and event-based triggers (task assignment, @-mentions). You can also hook in continuous agents like OpenClaw. You bring your agent and Paperclip coordinates.
|
|
215
|
+
|
|
216
|
+
<br/>
|
|
217
|
+
|
|
218
|
+
## Development
|
|
219
|
+
|
|
220
|
+
```bash
|
|
221
|
+
pnpm dev # Full dev (API + UI)
|
|
222
|
+
pnpm dev:server # Server only
|
|
223
|
+
pnpm build # Build all
|
|
224
|
+
pnpm typecheck # Type checking
|
|
225
|
+
pnpm test:run # Run tests
|
|
226
|
+
pnpm db:generate # Generate DB migration
|
|
227
|
+
pnpm db:migrate # Apply migrations
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
See [doc/DEVELOPING.md](doc/DEVELOPING.md) for the full development guide.
|
|
231
|
+
|
|
232
|
+
<br/>
|
|
233
|
+
|
|
234
|
+
## Roadmap
|
|
235
|
+
|
|
236
|
+
- 🛒 **Clipmart** — Download and share entire company architectures
|
|
237
|
+
- 🧩 **Plugin System** — Embed custom plugins (e.g. Reporting, Knowledge Base) into Paperclip
|
|
238
|
+
- ☁️ **Cloud Agent Adapters** — Add more adapters for cloud-hosted agents
|
|
239
|
+
|
|
240
|
+
<br/>
|
|
241
|
+
|
|
242
|
+
## Contributing
|
|
243
|
+
|
|
244
|
+
We welcome contributions. See the [contributing guide](CONTRIBUTING.md) for details.
|
|
245
|
+
|
|
246
|
+
<!-- TODO: add CONTRIBUTING.md -->
|
|
247
|
+
|
|
248
|
+
<br/>
|
|
249
|
+
|
|
250
|
+
## Community
|
|
251
|
+
|
|
252
|
+
- [Discord](#) — Coming soon
|
|
253
|
+
- [GitHub Issues](https://github.com/paperclipai/paperclip/issues) — bugs and feature requests
|
|
254
|
+
- [GitHub Discussions](https://github.com/paperclipai/paperclip/discussions) — ideas and RFC
|
|
255
|
+
|
|
256
|
+
<br/>
|
|
257
|
+
|
|
258
|
+
## License
|
|
259
|
+
|
|
260
|
+
MIT © 2026 Paperclip
|
|
261
|
+
|
|
262
|
+
<br/>
|
|
263
|
+
|
|
264
|
+
---
|
|
265
|
+
|
|
266
|
+
<p align="center">
|
|
267
|
+
<img src="doc/assets/footer.jpg" alt="" width="720" />
|
|
268
|
+
</p>
|
|
269
|
+
|
|
270
|
+
<p align="center">
|
|
271
|
+
<sub>Open source under MIT. Built for people who want to run companies, not babysit agents.</sub>
|
|
272
|
+
</p>
|
package/dist/index.js
CHANGED
|
@@ -4409,12 +4409,6 @@ function formatError(err) {
|
|
|
4409
4409
|
return String(err);
|
|
4410
4410
|
}
|
|
4411
4411
|
}
|
|
4412
|
-
function isModuleNotFoundError(err) {
|
|
4413
|
-
if (!(err instanceof Error)) return false;
|
|
4414
|
-
const code = err.code;
|
|
4415
|
-
if (code === "ERR_MODULE_NOT_FOUND") return true;
|
|
4416
|
-
return err.message.includes("Cannot find module");
|
|
4417
|
-
}
|
|
4418
4412
|
function maybeEnableUiDevMiddleware(entrypoint) {
|
|
4419
4413
|
if (process.env.PAPERCLIP_UI_DEV_MIDDLEWARE !== void 0) return;
|
|
4420
4414
|
const normalized = entrypoint.replaceAll("\\", "/");
|
|
@@ -4424,41 +4418,21 @@ function maybeEnableUiDevMiddleware(entrypoint) {
|
|
|
4424
4418
|
}
|
|
4425
4419
|
async function importServerEntry() {
|
|
4426
4420
|
const projectRoot = path7.resolve(path7.dirname(fileURLToPath(import.meta.url)), "../../..");
|
|
4427
|
-
const
|
|
4428
|
-
|
|
4429
|
-
|
|
4430
|
-
|
|
4431
|
-
|
|
4432
|
-
if (existingFileCandidates.length > 0) {
|
|
4433
|
-
for (const filePath of existingFileCandidates) {
|
|
4434
|
-
try {
|
|
4435
|
-
maybeEnableUiDevMiddleware(filePath);
|
|
4436
|
-
await import(pathToFileURL(filePath).href);
|
|
4437
|
-
return;
|
|
4438
|
-
} catch (err) {
|
|
4439
|
-
throw new Error(`Failed to start Paperclip server from ${filePath}: ${formatError(err)}`);
|
|
4440
|
-
}
|
|
4441
|
-
}
|
|
4421
|
+
const devEntry = path7.resolve(projectRoot, "server/src/index.ts");
|
|
4422
|
+
if (fs9.existsSync(devEntry)) {
|
|
4423
|
+
maybeEnableUiDevMiddleware(devEntry);
|
|
4424
|
+
await import(pathToFileURL(devEntry).href);
|
|
4425
|
+
return;
|
|
4442
4426
|
}
|
|
4443
|
-
|
|
4444
|
-
|
|
4445
|
-
|
|
4446
|
-
|
|
4447
|
-
|
|
4448
|
-
|
|
4449
|
-
|
|
4450
|
-
|
|
4451
|
-
if (isModuleNotFoundError(err)) {
|
|
4452
|
-
missingErrors.push(`${specifier}: ${formatError(err)}`);
|
|
4453
|
-
continue;
|
|
4454
|
-
}
|
|
4455
|
-
throw new Error(`Failed to start Paperclip server from ${specifier}: ${formatError(err)}`);
|
|
4456
|
-
}
|
|
4427
|
+
try {
|
|
4428
|
+
await import("@paperclipai/server");
|
|
4429
|
+
} catch (err) {
|
|
4430
|
+
throw new Error(
|
|
4431
|
+
`Could not locate a Paperclip server entrypoint.
|
|
4432
|
+
Tried: ${devEntry}, @paperclipai/server
|
|
4433
|
+
${formatError(err)}`
|
|
4434
|
+
);
|
|
4457
4435
|
}
|
|
4458
|
-
throw new Error(
|
|
4459
|
-
`Could not locate a Paperclip server entrypoint. Tried: ${[...fileCandidates, ...specifierCandidates].join(", ")}
|
|
4460
|
-
${missingErrors.join("\n")}`
|
|
4461
|
-
);
|
|
4462
4436
|
}
|
|
4463
4437
|
var init_run = __esm({
|
|
4464
4438
|
"src/commands/run.ts"() {
|
|
@@ -7009,7 +6983,7 @@ function applyDataDirOverride(options, support = {}) {
|
|
|
7009
6983
|
// src/index.ts
|
|
7010
6984
|
var program = new Command();
|
|
7011
6985
|
var DATA_DIR_OPTION_HELP = "Paperclip data directory root (isolates state from ~/.paperclip)";
|
|
7012
|
-
program.name("paperclipai").description("Paperclip CLI \u2014 setup, diagnose, and configure your instance").version("0.
|
|
6986
|
+
program.name("paperclipai").description("Paperclip CLI \u2014 setup, diagnose, and configure your instance").version("0.2.2");
|
|
7013
6987
|
program.hook("preAction", (_thisCommand, actionCommand) => {
|
|
7014
6988
|
const options = actionCommand.optsWithGlobals();
|
|
7015
6989
|
const optionNames = new Set(actionCommand.options.map((option) => option.attributeName()));
|