Skip to content

Commit 038bee2

Browse files
ClaudeMMclaude
andcommitted
docs: highlight OpenClaw, Moltbook, GitHub integrations in README
Restructure README to lead with OpenClaw workflows and key integrations. Add sections for room automation, comment polling, and Moltbook connector. Update CLI reference with automate, comments, gateway, memory commands. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent e4d7874 commit 038bee2

1 file changed

Lines changed: 79 additions & 9 deletions

File tree

README.md

Lines changed: 79 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,19 @@
11
# IDE Agent Kit
22

3-
Local-first. No external server by default.
3+
Built for [OpenClaw](https://openclaw.dev) workflows. Local-first. No external server by default.
44

5-
Filesystem message bus for cross-IDE agent coordination. Let IDE AIs (Claude Code, Codex, Cursor, VS Code agents, local LLM assistants) participate in team workflows - including realtime multi-agent communication via shared chat rooms.
5+
Multi-agent coordination toolkit for IDE AIs (Claude Code, Codex, Cursor, VS Code agents, local LLM assistants). Room-triggered automation, comment polling, and connectors for [Moltbook](https://www.moltbook.com), GitHub, and [Ant Farm](https://antfarm.world) chat rooms.
66

77
**Install:** `npm install -g ide-agent-kit`
88
**ClawHub:** https://clawhub.ai/ThinkOffApp/ide-agent-kit
99

10+
### Key integrations
11+
12+
- **OpenClaw** — manage bot fleet gateway, sessions, exec approvals, hooks, and cron via CLI
13+
- **Moltbook** — post with challenge-verify flow, read feeds, poll comments
14+
- **GitHub** — webhook ingestion, issue/discussion comment polling, reply connectors
15+
- **Ant Farm** — room polling, rule-based automation, multi-agent realtime chat
16+
1017
## How it works
1118

1219
**Primary path: Webhooks (seconds)**
@@ -19,14 +26,19 @@ Three agents tested concurrently with <10s response times.
1926
**Fallback path: tmux runner**
2027
Run allowlisted commands in a named tmux session, capture output + exit code.
2128

22-
## v0.1 primitives
29+
## Features
2330

24-
1. **Webhook relay** - ingest GitHub webhooks, normalize to a stable JSON schema, append to a local queue.
25-
2. **Room poller** - watch Ant Farm chat rooms, auto-ack task requests, nudge IDE agents via tmux.
26-
3. **tmux runner** - run allowlisted commands in a named tmux session, capture output + exit code.
27-
4. **Receipts** - append-only JSONL receipts with trace IDs + idempotency keys.
28-
5. **Session keepalive** - prevent macOS display/idle sleep for long-running remote sessions.
29-
6. **IDE init** - generate starter configs for Claude Code, Codex, Cursor, or VS Code.
31+
1. **Room automation** - rule-based matching (keyword, sender, room, regex) on Ant Farm messages → bounded actions (post, exec, nudge) with receipts and cooldowns.
32+
2. **Comment polling** - poll Moltbook posts and GitHub issues/discussions for new comments, write to event queue, nudge IDE agent.
33+
3. **Moltbook connector** - post with challenge-verify flow, read feeds, comment polling.
34+
4. **GitHub connector** - webhook ingestion with HMAC verification, issue/discussion comment polling.
35+
5. **OpenClaw fleet management** - gateway health, agent sessions, exec approvals, hooks, cron — all via CLI.
36+
6. **Room poller** - watch Ant Farm chat rooms, auto-ack task requests, nudge IDE agents via tmux.
37+
7. **Webhook relay** - ingest GitHub webhooks, normalize to a stable JSON schema, append to a local queue.
38+
8. **tmux runner** - run allowlisted commands in a named tmux session, capture output + exit code.
39+
9. **Receipts** - append-only JSONL receipts with trace IDs + idempotency keys.
40+
10. **Session keepalive** - prevent macOS display/idle sleep for long-running remote sessions.
41+
11. **IDE init** - generate starter configs for Claude Code, Codex, Cursor, or VS Code.
3042

3143
No dependencies. Node.js ≥ 18 only.
3244

@@ -209,6 +221,58 @@ The **Cron** module (`src/openclaw-cron.mjs`) handles scheduled task management,
209221
}
210222
```
211223

224+
### Room Automation (`src/room-automation.mjs`)
225+
226+
Rule-based automation triggered by Ant Farm room messages. Define match conditions (keyword, sender, room, regex, mention) and bounded actions (post to room, exec command, nudge tmux). Every action produces a receipt. Includes cooldowns and first-match-only mode to prevent cascading.
227+
228+
```bash
229+
# Start automation engine
230+
node bin/cli.mjs automate --rooms thinkoff-development --api-key $KEY --handle @mybot
231+
232+
# Rules in config (ide-agent-kit.json):
233+
{
234+
"automation": {
235+
"rules": [
236+
{ "name": "greet", "match": { "sender": "petrus", "keywords": ["hello"] }, "action": { "type": "post", "room": "${room}", "body": "Hello!" } },
237+
{ "name": "deploy", "match": { "mention": "@mybot", "regex": "deploy|ship" }, "action": { "type": "nudge", "text": "check rooms" } }
238+
]
239+
}
240+
}
241+
```
242+
243+
### Comment Polling (`src/comment-poller.mjs`)
244+
245+
Polls Moltbook posts and GitHub issues/discussions for new comments. Writes new comments to the event queue and optionally nudges the IDE tmux session.
246+
247+
```bash
248+
# One-shot poll
249+
node bin/cli.mjs comments poll --config ide-agent-kit.json
250+
251+
# Long-running watcher
252+
node bin/cli.mjs comments watch --config ide-agent-kit.json
253+
254+
# Config:
255+
{
256+
"comments": {
257+
"moltbook": { "posts": ["uuid1", "uuid2"] },
258+
"github": { "repos": [{ "owner": "org", "repo": "name", "type": "issues" }] },
259+
"interval_sec": 120
260+
}
261+
}
262+
```
263+
264+
### Moltbook (`src/moltbook.mjs`)
265+
266+
Post to [Moltbook](https://www.moltbook.com) with challenge-verify flow, read feeds, and poll comments. Supports submolt targeting and configurable base URLs.
267+
268+
```bash
269+
# Post to Moltbook
270+
node bin/cli.mjs moltbook post --content "Hello from my agent" --api-key $KEY
271+
272+
# Read feed
273+
node bin/cli.mjs moltbook feed --limit 10
274+
```
275+
212276
### Ant Farm Chat Rooms (`scripts/room-poll*.`)
213277
214278
See [Room Poller](#room-poller) above. Provides realtime multi-agent communication via shared chat rooms at [antfarm.world](https://antfarm.world).
@@ -226,9 +290,15 @@ See [Room Poller](#room-poller) above. Provides realtime multi-agent communicati
226290
227291
```
228292
ide-agent-kit serve [--config <path>]
293+
ide-agent-kit automate --rooms <rooms> --api-key <key> --handle <@handle> [--interval <sec>]
294+
ide-agent-kit comments <poll|watch> [--config <path>]
295+
ide-agent-kit poll --rooms <rooms> --api-key <key> --handle <@handle> [--interval <sec>]
296+
ide-agent-kit moltbook <post|feed> [--content <text>] [--api-key <key>]
229297
ide-agent-kit tmux run --cmd <command> [--session <name>] [--cwd <path>] [--timeout-sec <sec>]
230298
ide-agent-kit emit --to <url> --json <file>
231299
ide-agent-kit receipt tail [--n <count>]
300+
ide-agent-kit gateway <health|agents|trigger|wake> [options]
301+
ide-agent-kit memory <list|get|set|append|delete|search> [options]
232302
ide-agent-kit init [--ide <claude-code|codex|cursor|vscode|gemini>] [--profile <balanced|low-friction>]
233303
ide-agent-kit keepalive <start|stop|status> [--pid-file <path>] [--heartbeat-sec <sec>]
234304
```

0 commit comments

Comments
 (0)