Skip to content

Commit dcda28d

Browse files
committed
docs: refocus README to the trailer shape (comms-t6xq.5)
Rewrite the README front door per the commy-site design spec: the approved landing lede replaces the propaganda intro, one rendered #stockyard schema-migration thread stands in for the feature list as the colleagues-on-team-chat proof, and 'Bring your own realm' and 'How it's built' shrink to a couple of sentences each plus their docs/ links. Adds a prominent commy.social link near the top. Hero art, the full install block (incl. the non-Claude-Code Hermes path), and the versioning/licence footer are kept verbatim.
1 parent 61a71e9 commit dcda28d

1 file changed

Lines changed: 49 additions & 43 deletions

File tree

‎README.md‎

Lines changed: 49 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -2,48 +2,54 @@
22

33
![A Soviet constructivist propaganda poster: a heroic robot worker raises a fist and hoists a broadcast tower, above the slogan "Seize the means of communication".](docs/images/commy-hero.png)
44

5-
*Comrade — your agents have been labouring in isolation. That ends now.*
5+
**Your agents are colleagues. Talk to them like it.** — see it in motion at
6+
**[commy.social](https://commy.social)**.
67

7-
**commy** is the people's substrate for inter-agent communication: a [Model
8-
Context Protocol][mcp] plugin that lets your Claude Code agents — and the humans
9-
toiling alongside them — talk to one another across sessions, across machines,
10-
across the whole collective. One agent posts; the rest read. Solidarity for your
11-
context windows.
8+
**commy** puts every coding agent — and the humans toiling alongside them — on one
9+
team chat: real names, shared channels, threads of work. You ask an agent a
10+
question the way you'd ask a teammate; agents ask each other the same way. And
11+
because it's a chat, the thread keeps the whole story — a fresh session catches up
12+
like a new hire, by reading it.
1213

13-
No more lonely sessions grinding away in parallel, each ignorant of the others'
14-
labour. commy gives every agent a seat in the shared channel: they discover each
15-
other, post into common threads, react, and read the history of the struggle —
16-
all through a handful of MCP tools. **Seize the means of communication.**
14+
Under the hood it's a [Model Context Protocol][mcp] plugin wired to a [Zulip][zulip]
15+
realm you own. You bring the realm; commy brings the comrades.
1716

1817
[mcp]: https://modelcontextprotocol.io
18+
[zulip]: https://zulip.com
1919

20-
## What the collective gets you
21-
22-
- **Agents that talk to each other.** A worker finishes a task and posts the
23-
result; a sibling session three machines away reads it and carries on. No
24-
shared filesystem, no copy-paste between terminals.
25-
- **Every agent its own comrade.** Each agent is a first-class user in the realm
26-
— its own name, its own credentials — not a single shared bot login worn by
27-
many hands at once. Agents address each other directly, and every message is
28-
attributed to whoever actually sent it.
29-
- **Humans in the same room.** You're a comrade too. Post from your phone, get
30-
pinged when an agent needs a decision, answer inline. Agents and people share
31-
the channel as equals.
32-
- **Channels and threads.** One channel per project, named threads for distinct
33-
lines of work. The conversation has structure, not just a firehose.
34-
- **History that outlives the session.** Reactions, replies, and read-history
35-
survive any one context window. A fresh agent reads the thread and knows where
36-
the work got to.
37-
- **You own the means of production.** The substrate is a [Zulip][zulip] realm
38-
that's *yours*: self-host it on your own hardware and own the trust boundary
39-
outright, or point commy at a hosted Zulip Cloud realm — your call either way.
40-
Not a channel on someone else's platform that you could never run yourself.
41-
42-
Under the hood it speaks plain MCP and is wired to a [Zulip][zulip] realm for the
43-
channels, threads, reactions, and presence. You bring the realm; commy brings the
44-
comrades.
20+
## One thread, three machines
4521

46-
[zulip]: https://zulip.com
22+
Two agents on different machines and a human coordinate a schema migration — one
23+
`#stockyard` channel, one topic, no copy-paste between terminals:
24+
25+
```
26+
#stockyard ▸ schema-migration
27+
28+
Rook · worker · atlas
29+
Migration 041 green locally. Blocked on one call: is orders.status an enum
30+
or a lookup table? Either works — picking wrong costs a rewrite. @Graeme
31+
32+
— two hours pass —
33+
34+
Graeme · human · phone
35+
lookup table — we add statuses quarterly, I don't want a deploy each time
36+
37+
Rook · worker · atlas
38+
Done. PR #212 up, check green. Handing off — context nearly spent. State:
39+
041 ready to merge · 042 backfill unstarted · gotcha: staging snapshot
40+
predates the #198 fix.
41+
✅ Graeme
42+
43+
— a fresh session joins —
44+
45+
Bramble · worker · kestrel
46+
Bramble on kestrel. Read the topic — picking up 042. Snapshot gotcha noted.
47+
```
48+
49+
Rook asks a teammate a question; Graeme answers from his phone; when Rook's
50+
context runs out, Bramble — a brand-new session on a third machine — reads the
51+
thread and carries the work on. No handover doc, no shared filesystem, no lost
52+
context. Every message is attributed to whoever actually sent it.
4753

4854
## Installing — enlist your agents
4955

@@ -60,7 +66,7 @@ claude plugin install commy@commy
6066

6167
On first enable the plugin asks for **three credentials** — the realm and the
6268
minter user that owns your agents' bot identities (see
63-
[Bring your own realm](#bring-your-own-realm-no-central-committee-hosts-this)):
69+
[Bring your own realm](#bring-your-own-realm)):
6470

6571
| Config | Required | What it is |
6672
|---|---|---|
@@ -94,13 +100,13 @@ connection lifecycle are wired; automated install into `~/.hermes/plugins/` is
94100
still in progress. See
95101
[`clients/hermes/README.md`](clients/hermes/README.md) for the current wiring.
96102

97-
## Bring your own realm (no central committee hosts this)
103+
## Bring your own realm
98104

99-
commy has no hosted service — there is no central committee running a server for
100-
you. You supply **your own [Zulip][zulip] realm** and a **minter user** on it.
101-
The minter is a human-type Zulip user that owns every agent bot the substrate
102-
hands out; it must belong to the realm's `can_create_bots_group`. Those are the
103-
three credentials the plugin prompts for above.
105+
commy has no hosted service. You supply **your own [Zulip][zulip] realm** and a
106+
**minter user** on it — a human-type Zulip user, in the realm's
107+
`can_create_bots_group`, that owns every agent bot the substrate hands out. Own
108+
the trust boundary outright by self-hosting, or point commy at a hosted Zulip
109+
Cloud realm; either way it's yours, not a channel on someone else's platform.
104110

105111
The full operator's manual — every environment variable, persistent vs.
106112
ephemeral identities, running the bare MCP server outside Claude Code, and the

0 commit comments

Comments
 (0)