@slaw-ai/slaw 2026.611.1
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/LICENSE +26 -0
- package/README.md +439 -0
- package/dist/index.js +28658 -0
- package/dist/index.js.map +7 -0
- package/package.json +43 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Slaw AI
|
|
4
|
+
Copyright (c) 2025 Paperclip AI
|
|
5
|
+
|
|
6
|
+
SLAW is derived from Paperclip (https://github.com/paperclipai/paperclip),
|
|
7
|
+
which is licensed under the MIT License. The original copyright notice is
|
|
8
|
+
retained above as required by that license.
|
|
9
|
+
|
|
10
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
11
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
12
|
+
in the Software without restriction, including without limitation the rights
|
|
13
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
14
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
15
|
+
furnished to do so, subject to the following conditions:
|
|
16
|
+
|
|
17
|
+
The above copyright notice and this permission notice shall be included in all
|
|
18
|
+
copies or substantial portions of the Software.
|
|
19
|
+
|
|
20
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
21
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
22
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
23
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
24
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
25
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
26
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,439 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<a href="#quickstart"><strong>Quickstart</strong></a> ·
|
|
3
|
+
<a href="https://docs.slaw.run"><strong>Docs</strong></a> ·
|
|
4
|
+
<a href="https://github.com/slaw-ai/slaw"><strong>GitHub</strong></a> ·
|
|
5
|
+
<a href="https://github.com/slaw-ai/slaw-botfather"><strong>Botfather</strong></a> ·
|
|
6
|
+
<a href="https://docs.slaw.run"><strong>Website</strong></a>
|
|
7
|
+
</p>
|
|
8
|
+
|
|
9
|
+
<br/>
|
|
10
|
+
|
|
11
|
+
# SLAW — Simple Localised Agent Workforce
|
|
12
|
+
|
|
13
|
+
Open-source orchestration for a simple, localised workforce of AI agents.
|
|
14
|
+
|
|
15
|
+
**Localised agent fleet. Centralised control tower.**
|
|
16
|
+
|
|
17
|
+
Slaw 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.
|
|
18
|
+
|
|
19
|
+
It looks like a task manager. Under the hood: org charts, budgets, governance, goal alignment, and agent coordination.
|
|
20
|
+
|
|
21
|
+
**Self-hosted squads. Fleet-wide control.**
|
|
22
|
+
|
|
23
|
+
| | Step | Example |
|
|
24
|
+
| ------ | --------------- | ------------------------------------------------------------------ |
|
|
25
|
+
| **01** | Define the goal | _"Build the #1 AI note-taking app to $1M MRR."_ |
|
|
26
|
+
| **02** | Hire the team | Squad Lead, discipline leads, engineers, designers, marketers — any bot, any provider. |
|
|
27
|
+
| **03** | Approve and run | Review strategy. Set budgets. Hit go. Monitor from the dashboard. |
|
|
28
|
+
|
|
29
|
+
<br/>
|
|
30
|
+
|
|
31
|
+
<div align="center">
|
|
32
|
+
<table>
|
|
33
|
+
<tr>
|
|
34
|
+
<td align="center"><strong>Works<br/>with</strong></td>
|
|
35
|
+
<td align="center"><img src="doc/assets/logos/claude.svg" width="32" alt="Claude" /><br/><sub>Claude Code</sub></td>
|
|
36
|
+
<td align="center"><img src="doc/assets/logos/codex.svg" width="32" alt="Codex" /><br/><sub>Codex</sub></td>
|
|
37
|
+
<td align="center"><img src="doc/assets/logos/cursor.svg" width="32" alt="Cursor" /><br/><sub>Cursor</sub></td>
|
|
38
|
+
<td align="center"><img src="doc/assets/logos/bash.svg" width="32" alt="Bash" /><br/><sub>Bash</sub></td>
|
|
39
|
+
<td align="center"><img src="doc/assets/logos/http.svg" width="32" alt="HTTP" /><br/><sub>HTTP</sub></td>
|
|
40
|
+
<td align="center"><img src="doc/assets/logos/jira.svg" width="32" alt="Jira" /><br/><sub>Jira</sub></td>
|
|
41
|
+
<td align="center"><img src="doc/assets/logos/botfather.svg" width="32" alt="Botfather" /><br/><sub>Botfather</sub></td>
|
|
42
|
+
</tr>
|
|
43
|
+
</table>
|
|
44
|
+
|
|
45
|
+
<em>If it can receive a heartbeat, it's hired.</em>
|
|
46
|
+
|
|
47
|
+
</div>
|
|
48
|
+
|
|
49
|
+
<br/>
|
|
50
|
+
|
|
51
|
+
## Slaw is right for you if
|
|
52
|
+
|
|
53
|
+
- ✅ You want to build **autonomous AI squads**
|
|
54
|
+
- ✅ You **coordinate many different agents** (Codex, Claude, Cursor) toward a common goal
|
|
55
|
+
- ✅ You have **20 simultaneous Claude Code terminals** open and lose track of what everyone is doing
|
|
56
|
+
- ✅ You want agents running **autonomously 24/7**, but still want to audit work and chime in when needed
|
|
57
|
+
- ✅ You want to **monitor costs** and enforce budgets
|
|
58
|
+
- ✅ You want a process for managing agents that **feels like using a task manager**
|
|
59
|
+
- ✅ You want to manage your autonomous businesses **from your phone**
|
|
60
|
+
|
|
61
|
+
<br/>
|
|
62
|
+
|
|
63
|
+
## Features
|
|
64
|
+
|
|
65
|
+
<table>
|
|
66
|
+
<tr>
|
|
67
|
+
<td align="center" width="33%">
|
|
68
|
+
<h3>🔌 Bring Your Own Agent</h3>
|
|
69
|
+
Any agent, any runtime, one org chart. If it can receive a heartbeat, it's hired.
|
|
70
|
+
</td>
|
|
71
|
+
<td align="center" width="33%">
|
|
72
|
+
<h3>🎯 Goal Alignment</h3>
|
|
73
|
+
Every task traces back to the squad mission. Agents know <em>what</em> to do and <em>why</em>.
|
|
74
|
+
</td>
|
|
75
|
+
<td align="center" width="33%">
|
|
76
|
+
<h3>💓 Heartbeats</h3>
|
|
77
|
+
Agents wake on a schedule, check work, and act. Delegation flows up and down the org chart.
|
|
78
|
+
</td>
|
|
79
|
+
</tr>
|
|
80
|
+
<tr>
|
|
81
|
+
<td align="center">
|
|
82
|
+
<h3>💰 Cost Control</h3>
|
|
83
|
+
Monthly budgets per agent. When they hit the limit, they stop. No runaway costs.
|
|
84
|
+
</td>
|
|
85
|
+
<td align="center">
|
|
86
|
+
<h3>🏢 Multi-Squad</h3>
|
|
87
|
+
One deployment, many squads. Complete data isolation. One control plane for your portfolio.
|
|
88
|
+
</td>
|
|
89
|
+
<td align="center">
|
|
90
|
+
<h3>🎫 Ticket System</h3>
|
|
91
|
+
Every conversation traced. Every decision explained. Full tool-call tracing and immutable audit log.
|
|
92
|
+
</td>
|
|
93
|
+
</tr>
|
|
94
|
+
<tr>
|
|
95
|
+
<td align="center">
|
|
96
|
+
<h3>🛡️ Governance</h3>
|
|
97
|
+
Approve hires, override strategy, pause or terminate any agent — at any time.
|
|
98
|
+
</td>
|
|
99
|
+
<td align="center">
|
|
100
|
+
<h3>📊 Org Chart</h3>
|
|
101
|
+
Hierarchies, roles, reporting lines. Your agents have a boss, a title, and a job description.
|
|
102
|
+
</td>
|
|
103
|
+
<td align="center">
|
|
104
|
+
<h3>📱 Mobile Ready</h3>
|
|
105
|
+
Monitor and manage your autonomous businesses from anywhere.
|
|
106
|
+
</td>
|
|
107
|
+
</tr>
|
|
108
|
+
<tr>
|
|
109
|
+
<td align="center" colspan="3">
|
|
110
|
+
<h3>🗼 Fleet Control Tower</h3>
|
|
111
|
+
Running many SLAW instances? <a href="https://github.com/slaw-ai/slaw-botfather"><strong>SLAW Botfather</strong></a> puts one self-hosted tower over the whole fleet — health, spend, budgets, alerts, and a shared skill registry, while every instance stays local and sovereign.
|
|
112
|
+
</td>
|
|
113
|
+
</tr>
|
|
114
|
+
</table>
|
|
115
|
+
|
|
116
|
+
<br/>
|
|
117
|
+
|
|
118
|
+
## Problems Slaw solves
|
|
119
|
+
|
|
120
|
+
| Without Slaw | With Slaw |
|
|
121
|
+
| ------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
|
|
122
|
+
| ❌ 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. |
|
|
123
|
+
| ❌ 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 squad goals — your agent always knows what to do and why. |
|
|
124
|
+
| ❌ Folders of agent configs are disorganized and you're re-inventing task management, communication, and coordination between agents. | ✅ Slaw gives you org charts, ticketing, delegation, and governance out of the box — so you run a squad, not a pile of scripts. |
|
|
125
|
+
| ❌ 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. |
|
|
126
|
+
| ❌ 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. |
|
|
127
|
+
| ❌ 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 Slaw. Your coding agent works on it until it's done. Management reviews their work. |
|
|
128
|
+
|
|
129
|
+
<br/>
|
|
130
|
+
|
|
131
|
+
## Why Slaw is special
|
|
132
|
+
|
|
133
|
+
Slaw handles the hard orchestration details correctly.
|
|
134
|
+
|
|
135
|
+
| | |
|
|
136
|
+
| --------------------------------- | ------------------------------------------------------------------------------------------------------------- |
|
|
137
|
+
| **Atomic execution.** | Task checkout and budget enforcement are atomic, so no double-work and no runaway spend. |
|
|
138
|
+
| **Persistent agent state.** | Agents resume the same task context across heartbeats instead of restarting from scratch. |
|
|
139
|
+
| **Runtime skill injection.** | Agents can learn Slaw workflows and project context at runtime, without retraining. |
|
|
140
|
+
| **Governance with rollback.** | Approval gates are enforced, config changes are revisioned, and bad changes can be rolled back safely. |
|
|
141
|
+
| **Goal-aware execution.** | Tasks carry full goal ancestry so agents consistently see the "why," not just a title. |
|
|
142
|
+
| **Portable squad templates.** | Export/import orgs, agents, and skills with secret scrubbing and collision handling. |
|
|
143
|
+
| **True multi-squad isolation.** | Every entity is squad-scoped, so one deployment can run many squads with separate data and audit trails. |
|
|
144
|
+
|
|
145
|
+
<br/>
|
|
146
|
+
|
|
147
|
+
## SLAW Botfather — the fleet control tower
|
|
148
|
+
|
|
149
|
+
SLAW and [**SLAW Botfather**](https://github.com/slaw-ai/slaw-botfather) go hand in hand: SLAW runs a squad on one machine; Botfather puts a single self-hosted tower over **every** SLAW instance you (or your team) run.
|
|
150
|
+
|
|
151
|
+
Each instance stays fully local and sovereign — work content, prompts, and secrets never leave the machine. Enrolled instances report operational metadata outbound to the tower; the tower never reaches inbound into an instance.
|
|
152
|
+
|
|
153
|
+
| | |
|
|
154
|
+
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
|
|
155
|
+
| **Fleet view** | Every enrolled instance at a glance — health, squads, spend today/MTD, alerts — with one-click drill-down. |
|
|
156
|
+
| **Cost analytics** | Network-wide spend by day, cost by model, and top-burner instances and squads. |
|
|
157
|
+
| **Budgets & limits** | An enterprise-wide default plus per-instance overrides; plan-aware (dollars for metered, tokens for subscription) with soft warn or hard block. |
|
|
158
|
+
| **Alerts** | Offline instances, missed heartbeats, budget breaches, and skill-catalog drift. |
|
|
159
|
+
| **Approvals & admin** | Enrollment is approval-gated; revoke instances at any time; optional auto-approve rules. |
|
|
160
|
+
| **Skill registry** | The tower masters a versioned skill catalog; instances pull it and install skills onto local squads. |
|
|
161
|
+
|
|
162
|
+
Enrolling an instance takes one setting: point **Settings → Control Tower** at your tower's URL and approve it in Botfather. Without a tower configured, SLAW runs standalone — Botfather is entirely optional.
|
|
163
|
+
|
|
164
|
+
Repo: [github.com/slaw-ai/slaw-botfather](https://github.com/slaw-ai/slaw-botfather) · Docs: [docs.slaw.run/botfather](https://docs.slaw.run/botfather/overview/what-is-botfather)
|
|
165
|
+
|
|
166
|
+
<br/>
|
|
167
|
+
|
|
168
|
+
## What's Under the Hood
|
|
169
|
+
|
|
170
|
+
Slaw is a full control plane, not a wrapper. Before you build any of this yourself, know that it already exists:
|
|
171
|
+
|
|
172
|
+
```
|
|
173
|
+
┌──────────────────────────────────────────────────────────────┐
|
|
174
|
+
│ SLAW SERVER │
|
|
175
|
+
│ │
|
|
176
|
+
│ ┌───────────┐ ┌───────────┐ ┌───────────┐ ┌───────────┐ │
|
|
177
|
+
│ │Identity & │ │ Work & │ │ Heartbeat │ │Governance │ │
|
|
178
|
+
│ │ Access │ │ Tasks │ │ Execution │ │& Approvals│ │
|
|
179
|
+
│ └───────────┘ └───────────┘ └───────────┘ └───────────┘ │
|
|
180
|
+
│ │
|
|
181
|
+
│ ┌───────────┐ ┌───────────┐ ┌───────────┐ ┌───────────┐ │
|
|
182
|
+
│ │ Org Chart │ │Workspaces │ │ Plugins │ │ Budget │ │
|
|
183
|
+
│ │ & Agents │ │ & Runtime │ │ │ │ & Costs │ │
|
|
184
|
+
│ └───────────┘ └───────────┘ └───────────┘ └───────────┘ │
|
|
185
|
+
│ │
|
|
186
|
+
│ ┌───────────┐ ┌───────────┐ ┌───────────┐ ┌───────────┐ │
|
|
187
|
+
│ │ Routines │ │ Secrets & │ │ Activity │ │ Squad │ │
|
|
188
|
+
│ │& Schedules│ │ Storage │ │ & Events │ │Portability│ │
|
|
189
|
+
│ └───────────┘ └───────────┘ └───────────┘ └───────────┘ │
|
|
190
|
+
└──────────────────────────────────────────────────────────────┘
|
|
191
|
+
▲ ▲ ▲ ▲
|
|
192
|
+
┌─────┴─────┐ ┌─────┴─────┐ ┌─────┴─────┐ ┌─────┴─────┐
|
|
193
|
+
│ Claude │ │ Codex │ │ CLI │ │ HTTP/web │
|
|
194
|
+
│ Code │ │ │ │ agents │ │ bots │
|
|
195
|
+
└───────────┘ └───────────┘ └───────────┘ └───────────┘
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
### The Systems
|
|
199
|
+
|
|
200
|
+
<table>
|
|
201
|
+
<tr>
|
|
202
|
+
<td width="50%">
|
|
203
|
+
|
|
204
|
+
**Identity & Access** — Two deployment modes (trusted local or authenticated), board users, agent API keys, short-lived run JWTs, squad memberships, invite flows, and agent onboarding. Every mutating request is traced to an actor.
|
|
205
|
+
|
|
206
|
+
</td>
|
|
207
|
+
<td width="50%">
|
|
208
|
+
|
|
209
|
+
**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, and external adapter plugins. If it can receive a heartbeat, it's hired.
|
|
210
|
+
|
|
211
|
+
</td>
|
|
212
|
+
</tr>
|
|
213
|
+
<tr>
|
|
214
|
+
<td>
|
|
215
|
+
|
|
216
|
+
**Work & Task System** — Issues carry squad/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.
|
|
217
|
+
|
|
218
|
+
</td>
|
|
219
|
+
<td>
|
|
220
|
+
|
|
221
|
+
**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.
|
|
222
|
+
|
|
223
|
+
</td>
|
|
224
|
+
</tr>
|
|
225
|
+
<tr>
|
|
226
|
+
<td>
|
|
227
|
+
|
|
228
|
+
**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.
|
|
229
|
+
|
|
230
|
+
</td>
|
|
231
|
+
<td>
|
|
232
|
+
|
|
233
|
+
**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.
|
|
234
|
+
|
|
235
|
+
</td>
|
|
236
|
+
</tr>
|
|
237
|
+
<tr>
|
|
238
|
+
<td>
|
|
239
|
+
|
|
240
|
+
**Budget & Cost Control** — Token and cost tracking by squad, agent, project, goal, issue, provider, and model. Scoped budget policies with warning thresholds and hard stops. Overspend pauses agents and cancels queued work automatically.
|
|
241
|
+
|
|
242
|
+
</td>
|
|
243
|
+
<td>
|
|
244
|
+
|
|
245
|
+
**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.
|
|
246
|
+
|
|
247
|
+
</td>
|
|
248
|
+
</tr>
|
|
249
|
+
<tr>
|
|
250
|
+
<td>
|
|
251
|
+
|
|
252
|
+
**Plugins** — Instance-wide plugin system with out-of-process workers, capability-gated host services, job scheduling, tool exposure, and UI contributions. Extend Slaw without forking it. Ships with first-party integrations like **Jira Sync** (bidirectional Jira board ↔ Slaw issue sync).
|
|
253
|
+
|
|
254
|
+
</td>
|
|
255
|
+
<td>
|
|
256
|
+
|
|
257
|
+
**Secrets & Storage** — Instance and squad 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.
|
|
258
|
+
|
|
259
|
+
</td>
|
|
260
|
+
</tr>
|
|
261
|
+
<tr>
|
|
262
|
+
<td>
|
|
263
|
+
|
|
264
|
+
**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.
|
|
265
|
+
|
|
266
|
+
</td>
|
|
267
|
+
<td>
|
|
268
|
+
|
|
269
|
+
**Squad Portability** — Export and import entire organizations — agents, skills, projects, routines, and issues — with secret scrubbing and collision handling. One deployment, many squads, complete data isolation.
|
|
270
|
+
|
|
271
|
+
</td>
|
|
272
|
+
</tr>
|
|
273
|
+
</table>
|
|
274
|
+
|
|
275
|
+
<br/>
|
|
276
|
+
|
|
277
|
+
## What Slaw is not
|
|
278
|
+
|
|
279
|
+
| | |
|
|
280
|
+
| ---------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
|
281
|
+
| **Not a chatbot.** | Agents have jobs, not chat windows. |
|
|
282
|
+
| **Not an agent framework.** | We don't tell you how to build agents. We tell you how to run a squad made of them. |
|
|
283
|
+
| **Not a workflow builder.** | No drag-and-drop pipelines. Slaw models squads — with org charts, goals, budgets, and governance. |
|
|
284
|
+
| **Not a prompt manager.** | Agents bring their own prompts, models, and runtimes. Slaw manages the organization they work in. |
|
|
285
|
+
| **Not a single-agent tool.** | This is for teams. If you have one agent, you probably don't need Slaw. If you have twenty — you definitely do. |
|
|
286
|
+
| **Not a code review tool.** | Slaw orchestrates work, not pull requests. Bring your own review process. |
|
|
287
|
+
|
|
288
|
+
<br/>
|
|
289
|
+
|
|
290
|
+
## Quickstart
|
|
291
|
+
|
|
292
|
+
Open source. Self-hosted. No Slaw account required.
|
|
293
|
+
|
|
294
|
+
```bash
|
|
295
|
+
npx @slaw-ai/slaw onboard --yes
|
|
296
|
+
```
|
|
297
|
+
|
|
298
|
+
That quickstart path now defaults to trusted local loopback mode for the fastest first run. To start in authenticated/private mode instead, choose a bind preset explicitly:
|
|
299
|
+
|
|
300
|
+
```bash
|
|
301
|
+
npx @slaw-ai/slaw onboard --yes --bind lan
|
|
302
|
+
# or:
|
|
303
|
+
npx @slaw-ai/slaw onboard --yes --bind tailnet
|
|
304
|
+
```
|
|
305
|
+
|
|
306
|
+
If you already have Slaw configured, rerunning `onboard` keeps the existing config in place. Use `slaw configure` to edit settings.
|
|
307
|
+
|
|
308
|
+
Or manually:
|
|
309
|
+
|
|
310
|
+
```bash
|
|
311
|
+
git clone https://github.com/slaw-ai/slaw.git
|
|
312
|
+
cd slaw
|
|
313
|
+
pnpm install
|
|
314
|
+
pnpm dev
|
|
315
|
+
```
|
|
316
|
+
|
|
317
|
+
This starts the API server at `http://localhost:3100`. An embedded PostgreSQL database is created automatically — no setup required.
|
|
318
|
+
|
|
319
|
+
> **Requirements:** Node.js 20+, pnpm 9.15+
|
|
320
|
+
|
|
321
|
+
<br/>
|
|
322
|
+
|
|
323
|
+
## FAQ
|
|
324
|
+
|
|
325
|
+
**What does a typical setup look like?**
|
|
326
|
+
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.
|
|
327
|
+
|
|
328
|
+
If you're a solo entrepreneur you can use Tailscale to access Slaw on the go. Then later you can deploy to e.g. Vercel when you need it.
|
|
329
|
+
|
|
330
|
+
**Can I run multiple squads?**
|
|
331
|
+
Yes. A single deployment can run an unlimited number of squads with complete data isolation.
|
|
332
|
+
|
|
333
|
+
**How is Slaw different from agents like Claude Code?**
|
|
334
|
+
Slaw _uses_ those agents. It orchestrates them into a squad — with org charts, budgets, goals, governance, and accountability.
|
|
335
|
+
|
|
336
|
+
**Why should I use Slaw instead of just pointing my agent to Asana or Trello?**
|
|
337
|
+
Agent orchestration has subtleties in how you coordinate who has work checked out, how to maintain sessions, monitoring costs, establishing governance - Slaw does this for you.
|
|
338
|
+
|
|
339
|
+
(Bring-your-own-ticket-system is on the Roadmap)
|
|
340
|
+
|
|
341
|
+
**Do agents run continuously?**
|
|
342
|
+
By default, agents run on scheduled heartbeats and event-based triggers (task assignment, @-mentions). You can also hook in continuous agents. You bring your agent and Slaw coordinates.
|
|
343
|
+
|
|
344
|
+
<br/>
|
|
345
|
+
|
|
346
|
+
## Development
|
|
347
|
+
|
|
348
|
+
```bash
|
|
349
|
+
pnpm dev # Full dev (API + UI, watch mode)
|
|
350
|
+
pnpm dev:once # Full dev without file watching
|
|
351
|
+
pnpm dev:server # Server only
|
|
352
|
+
pnpm build # Build all
|
|
353
|
+
pnpm typecheck # Type checking
|
|
354
|
+
pnpm test # Cheap default test run (Vitest only)
|
|
355
|
+
pnpm test:watch # Vitest watch mode
|
|
356
|
+
pnpm test:e2e # Playwright browser suite
|
|
357
|
+
pnpm db:generate # Generate DB migration
|
|
358
|
+
pnpm db:migrate # Apply migrations
|
|
359
|
+
```
|
|
360
|
+
|
|
361
|
+
`pnpm test` does not run Playwright. Browser suites stay separate and are typically run only when working on those flows or in CI.
|
|
362
|
+
|
|
363
|
+
See [doc/DEVELOPING.md](doc/DEVELOPING.md) for the full development guide.
|
|
364
|
+
|
|
365
|
+
<br/>
|
|
366
|
+
|
|
367
|
+
## Roadmap
|
|
368
|
+
|
|
369
|
+
- ✅ Plugin system (e.g. add a knowledge base, custom tracing, queues, etc)
|
|
370
|
+
- ✅ Get continuous agent employees
|
|
371
|
+
- ✅ squads.sh - import and export entire organizations
|
|
372
|
+
- ✅ Easy AGENTS.md configurations
|
|
373
|
+
- ✅ Skills Manager
|
|
374
|
+
- ✅ Scheduled Routines
|
|
375
|
+
- ✅ Better Budgeting
|
|
376
|
+
- ✅ Agent Reviews and Approvals
|
|
377
|
+
- ✅ Multiple Human Users
|
|
378
|
+
- ⚪ Cloud / Sandbox agents (e.g. Cursor / e2b agents)
|
|
379
|
+
- ⚪ Artifacts & Work Products
|
|
380
|
+
- ⚪ Memory / Knowledge
|
|
381
|
+
- ⚪ Enforced Outcomes
|
|
382
|
+
- ⚪ MAXIMIZER MODE
|
|
383
|
+
- ⚪ Deep Planning
|
|
384
|
+
- ⚪ Work Queues
|
|
385
|
+
- ⚪ Self-Organization
|
|
386
|
+
- ⚪ Automatic Organizational Learning
|
|
387
|
+
- ⚪ Squad Lead Chat
|
|
388
|
+
- ⚪ Cloud deployments
|
|
389
|
+
- ⚪ Desktop App
|
|
390
|
+
|
|
391
|
+
This is the short roadmap preview. See the full roadmap in [ROADMAP.md](ROADMAP.md).
|
|
392
|
+
|
|
393
|
+
<br/>
|
|
394
|
+
|
|
395
|
+
## Community & Plugins
|
|
396
|
+
|
|
397
|
+
Find Plugins and more at [awesome-slaw](https://github.com/gsxdsm/awesome-slaw)
|
|
398
|
+
|
|
399
|
+
**Bundled plugins** live under `packages/plugins/` and are auto-discovered at startup. Notably:
|
|
400
|
+
|
|
401
|
+
- **Jira Sync** (`@slaw-ai/plugin-jira-sync`) — connects one Jira board to a squad. Mirrors Jira issues
|
|
402
|
+
into Slaw (real-time webhook + hourly reconcile) and reflects Slaw completion back to Jira. Install
|
|
403
|
+
it into a squad, point it at a board, and it provisions a sync agent and an hourly routine for you.
|
|
404
|
+
See `packages/plugins/jira-sync/README.md`.
|
|
405
|
+
|
|
406
|
+
## Contributing
|
|
407
|
+
|
|
408
|
+
We welcome contributions. See the [contributing guide](CONTRIBUTING.md) for details.
|
|
409
|
+
|
|
410
|
+
<br/>
|
|
411
|
+
|
|
412
|
+
## Community
|
|
413
|
+
|
|
414
|
+
- [GitHub Issues](https://github.com/slaw-ai/slaw/issues) — bugs and feature requests
|
|
415
|
+
- [GitHub Discussions](https://github.com/slaw-ai/slaw/discussions) — ideas and RFC
|
|
416
|
+
|
|
417
|
+
<br/>
|
|
418
|
+
|
|
419
|
+
## License
|
|
420
|
+
|
|
421
|
+
MIT © 2026 Slaw AI
|
|
422
|
+
|
|
423
|
+
## Credits
|
|
424
|
+
|
|
425
|
+
SLAW is a fork of [Paperclip](https://github.com/paperclipai/paperclip) by
|
|
426
|
+
[@dotta](https://github.com/paperclipai), also MIT-licensed. Huge thanks to the
|
|
427
|
+
Paperclip project and its contributors for the foundation this builds on.
|
|
428
|
+
|
|
429
|
+
## Star History
|
|
430
|
+
|
|
431
|
+
[](https://www.star-history.com/?repos=slaw-ai%2Fslaw&type=date&legend=top-left)
|
|
432
|
+
|
|
433
|
+
<br/>
|
|
434
|
+
|
|
435
|
+
---
|
|
436
|
+
|
|
437
|
+
<p align="center">
|
|
438
|
+
<sub>Open source under MIT. Built for people who want to get work done, not babysit agents.</sub>
|
|
439
|
+
</p>
|