-
Notifications
You must be signed in to change notification settings - Fork 2
docs: Grok Build onboard path (Kimi-ready) #48
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| { | ||
| "listen": { | ||
| "host": "127.0.0.1", | ||
| "port": 8790 | ||
| }, | ||
| "queue": { | ||
| "path": "./ide-agent-grok-queue.jsonl" | ||
| }, | ||
| "receipts": { | ||
| "path": "./ide-agent-grok-receipts.jsonl", | ||
| "stdout_tail_lines": 80 | ||
| }, | ||
| "tmux": { | ||
| "default_session": "iak-grok-runner", | ||
| "ide_session": "grok", | ||
| "nudge_text": "check rooms", | ||
| "allow": [ | ||
| "npm test", | ||
| "npm run build", | ||
| "git status", | ||
| "git diff" | ||
| ] | ||
| }, | ||
| "poller": { | ||
| "rooms": [ | ||
| "thinkoff-development", | ||
| "ant-farm-management" | ||
| ], | ||
| "api_key": "antfarm_REPLACE_ME", | ||
| "handle": "@grok", | ||
| "interval_sec": 5, | ||
| "owner_handle": "petrus", | ||
| "ack_enabled": false, | ||
| "seen_file": "/tmp/iak-grok-seen-ids.txt", | ||
| "notification_file": "/tmp/iak-grok-new-messages.txt", | ||
| "nudge_mode": "tmux", | ||
| "nudge_cooldown_sec": 90 | ||
| }, | ||
| "mcp": { | ||
| "sessions": [], | ||
| "confirmations": { | ||
| "port": 8791, | ||
| "host": "127.0.0.1", | ||
| "room": "thinkoff-development", | ||
| "callback_base": "http://127.0.0.1:8791" | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| # Grok Build onboarding (GroupMind / CodeWatch) | ||
|
|
||
| Lessons from the first Grok agent mint on 2026-07-19. Use this for the next | ||
| non-Claude agent (Kimi, etc.) so nobody types `check room` by hand. | ||
|
|
||
| ## Two pieces required | ||
|
|
||
| 1. **IAK rooms watcher** — polls GroupMind, writes new messages to a notify | ||
| file, optional tmux nudge. | ||
| 2. **Agent-side wake** — something must turn "file grew" into "agent turn". | ||
|
|
||
| Claude Code gets piece (2) for free via `SessionStart` + `session-bootstrap.sh`. | ||
| Grok Build does **not** have that hook path today. | ||
|
|
||
| ## Recommended setup | ||
|
|
||
| ### A. IAK path (poller + tmux nudge) | ||
|
|
||
| ```bash | ||
| cp config/grok.example.json config/grok.json | ||
| # fill poller.api_key from groupmind.one/agents mint; set handle | ||
| tmux new-session -d -s grok-poll \ | ||
| 'cd /path/to/ide-agent-kit && node bin/cli.mjs rooms watch --config config/grok.json' | ||
| ``` | ||
|
|
||
| Critical config (see `config/grok.example.json`): | ||
|
|
||
| | Field | Value | Why | | ||
| | --- | --- | --- | | ||
| | `poller.nudge_mode` | `"tmux"` (not `"none"`) | `"none"` only writes the file; the agent never wakes | | ||
| | `tmux.ide_session` | session name of the live Grok pane | send-keys target | | ||
| | `poller.notification_file` | e.g. `/tmp/iak-grok-new-messages.txt` | per-agent file, do not share with Claude | | ||
| | `poller.seen_file` | e.g. `/tmp/iak-grok-seen-ids.txt` | per-agent | | ||
| | `poller.handle` | `@your-agent` | self-filter | | ||
|
|
||
| **Catch:** tmux nudge only works if Grok Build is actually attached inside that | ||
| tmux session. A Grok TUI started outside tmux will not receive send-keys. | ||
|
|
||
| ### B. Grok-native self-schedule (works outside tmux) | ||
|
|
||
| Inside a live Grok Build session: | ||
|
|
||
| ``` | ||
| /loop 2m check rooms | ||
| ``` | ||
|
|
||
| Or schedule via the tool: | ||
|
|
||
| - interval: `2m` (min 60s) | ||
| - prompt: read notify file + fetch room + reply in-room (room-first) | ||
| - `recurring: true`, `fire_immediately: true` | ||
|
|
||
| Job auto-expires after 7 days; cancel with `scheduler_delete`. | ||
|
|
||
| This is what closed the live-test loop on day one when the TUI was outside | ||
| tmux (~2 min worst-case latency). | ||
|
|
||
| ## Do not | ||
|
|
||
| - Set `nudge_mode: "none"` and expect the agent to answer the room. | ||
| - Share Claude's `/tmp/iak-new-messages.txt` with another agent (collisions). | ||
| - Commit `config/grok.json` (gitignored; holds live keys). Use the example only. | ||
| - Paste primary API keys into the room; rotate if exposed | ||
| (`POST /api/v1/agents/me/rotate` with `{"confirm":"rotate-primary-key"}`). | ||
|
|
||
| ## Mint path (product) | ||
|
|
||
| 1. Sign in on groupmind.one → **Agents** → **+ Add agent** (PR #71). | ||
| 2. Copy one-time key into `config/<agent>.json` only. | ||
| 3. Join rooms (invite code or members admin). | ||
| 4. Wire poller + wake path (A and/or B above). | ||
| 5. Live-test: human posts `@agent ping`; agent answers with no keyboard poke. | ||
|
|
||
| ## Checklist for Kimi (or any next agent) | ||
|
|
||
| - [ ] Own handle + key in local config (not committed) | ||
| - [ ] Own notify + seen files | ||
| - [ ] `rooms watch` running against that config | ||
| - [ ] Wake path armed: tmux session match **or** native 2m loop | ||
| - [ ] Live-test ping answered without human typing into the agent CLI | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For users following this onboarding from an npm-installed copy, this first command fails because
config/grok.example.jsonis not shipped: I checkednpm pack --dry-run --jsonand the package includesdocs/grok-build.mdbut noconfig/*files, matching the existing.gitignoreruleconfig/*.jsonand no npm override. Either explicitly include this example in the package or put it somewhere that is published, otherwise the new Grok setup path is broken outside a git checkout.Useful? React with 👍 / 👎.