You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 79bcee5
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: AGENTS.md
+47-47Lines changed: 47 additions & 47 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,14 @@
1
1
# AGENTS.md — AI Agent Contributor Guide
2
2
3
-
This guide is for AI agents contributing to the Sprout codebase. It covers
3
+
This guide is for AI agents contributing to the Buzz codebase. It covers
4
4
agent-specific context and conventions. For general contributor info (setup,
5
5
code style, PR process, architecture), see [CONTRIBUTING.md](CONTRIBUTING.md).
6
6
7
7
---
8
8
9
9
## Ecosystem
10
10
11
-
Sprout spans five repos. This one (`block/sprout`) is the OSS source for the relay, desktop, mobile, and CLI. The others handle internal builds and deployment:
11
+
Buzz spans five repos. This one (`block/sprout`) is the OSS source for the relay, desktop, mobile, and CLI. The others handle internal builds and deployment:
12
12
13
13
| Repo | Purpose |
14
14
|------|---------|
@@ -37,32 +37,32 @@ access information.
37
37
```
38
38
crates/
39
39
# Relay + core
40
-
sprout-relay # WebSocket relay server — main entry point; also hosts git + huddle audio
**Event kinds**: All event kind integers are defined in
143
-
`sprout-core/src/kind.rs`. New features get new kind integers — add them here
143
+
`buzz-core/src/kind.rs`. New features get new kind integers — add them here
144
144
first, then implement handling in the relay.
145
145
146
146
**Channel scoping**: Channels use `h` tags (NIP-29 group tag), not `e` tags.
147
147
Filters and queries must scope to `h` tags when operating within a channel.
148
148
149
-
**Agent-facing operations go in `sprout-cli`**: New agent-facing features belong in `sprout-cli` — add a subcommand there first, then wire the REST/WebSocket call in `client.rs`. `sprout-dev-mcp` (shell + file tools for `sprout-agent`) is separate.
149
+
**Agent-facing operations go in `buzz-cli`**: New agent-facing features belong in `buzz-cli` — add a subcommand there first, then wire the REST/WebSocket call in `client.rs`. `buzz-dev-mcp` (shell + file tools for `buzz-agent`) is separate.
150
150
151
-
**Workflow conditions**: `sprout-workflow` uses
151
+
**Workflow conditions**: `buzz-workflow` uses
152
152
[evalexpr](https://docs.rs/evalexpr) for condition evaluation. Keep expressions
153
153
simple and testable.
154
154
@@ -158,20 +158,20 @@ check existing reply handlers for the pattern.
158
158
159
159
---
160
160
161
-
## Agent CLI (`sprout-cli`)
161
+
## Agent CLI (`buzz-cli`)
162
162
163
-
`sprout` is the agent-first CLI. Auth env vars
164
-
(`SPROUT_RELAY_URL`, `SPROUT_PRIVATE_KEY`, `SPROUT_AUTH_TAG`) are auto-injected
163
+
`buzz` is the agent-first CLI. Auth env vars
164
+
(`BUZZ_RELAY_URL`, `BUZZ_PRIVATE_KEY`, `BUZZ_AUTH_TAG`) are auto-injected
165
165
by the ACP harness into managed agent subprocesses. In development, set
166
-
`SPROUT_PRIVATE_KEY` and `SPROUT_RELAY_URL` in your environment manually.
166
+
`BUZZ_PRIVATE_KEY` and `BUZZ_RELAY_URL` in your environment manually.
167
167
168
168
### Building the CLI
169
169
170
170
```bash
171
-
cargo build --release -p sprout-cli
171
+
cargo build --release -p buzz-cli
172
172
```
173
173
174
-
Binary location: `./target/release/sprout`. Add `./target/release` to `PATH`
174
+
Binary location: `./target/release/buzz`. Add `./target/release` to `PATH`
`--format compact` is a **global** flag — it goes before the subcommand:
195
-
`sprout --format compact channels list`, NOT `sprout channels list --format compact`.
195
+
`buzz --format compact channels list`, NOT `buzz channels list --format compact`.
196
196
197
-
See `crates/sprout-cli/TESTING.md` for the full live-testing runbook.
197
+
See `crates/buzz-cli/TESTING.md` for the full live-testing runbook.
198
198
199
199
---
200
200
@@ -205,7 +205,7 @@ just test-unit # unit tests, no infrastructure needed
205
205
just test# full integration suite (requires Postgres + Redis)
206
206
```
207
207
208
-
E2E tests live in `crates/sprout-test-client/tests/`:
208
+
E2E tests live in `crates/buzz-test-client/tests/`:
209
209
-`e2e_relay.rs` — WebSocket relay protocol
210
210
-`e2e_rest_api.rs` — REST endpoint coverage
211
211
-`e2e_tokens.rs` — auth token flows
@@ -220,7 +220,7 @@ See [TESTING.md](TESTING.md) for the full multi-agent E2E guide.
220
220
221
221
### Desktop Screenshots (Playwright)
222
222
223
-
> **Do NOT use `sprout upload`, the relay media endpoint, or any third-party
223
+
> **Do NOT use `buzz upload`, the relay media endpoint, or any third-party
224
224
> image host for PR screenshots.** Relay media URLs fail through GitHub's camo
225
225
> proxy. Always use `scripts/post-screenshots.sh` — see the `desktop-screenshot`
226
226
> skill for the full workflow.
@@ -246,7 +246,7 @@ Output is a PNG path on stdout.
246
246
247
247
Use `--messages` to inject content into a channel before capture. The JSON file
248
248
is an array of objects — `channelName` and `content` are required, all other
249
-
fields are optional and passed through to `__SPROUT_E2E_EMIT_MOCK_MESSAGE__`:
249
+
fields are optional and passed through to `__BUZZ_E2E_EMIT_MOCK_MESSAGE__`:
250
250
251
251
```json
252
252
[
@@ -350,7 +350,7 @@ must run BEFORE `installMockBridge(page)` — React reads state on mount, the
350
350
bridge triggers mount.
351
351
352
352
**Live messages:** Call `waitForMockLiveSubscription(page, channelName)` before
353
-
`__SPROUT_E2E_EMIT_MOCK_MESSAGE__` — messages are silently dropped without a
353
+
`__BUZZ_E2E_EMIT_MOCK_MESSAGE__` — messages are silently dropped without a
354
354
subscription. Navigate to the channel first (triggers subscription), then away
355
355
(so unread indicators appear), then inject.
356
356
@@ -393,7 +393,7 @@ description. See [PR #803](https://github.com/block/sprout/pull/803).
393
393
394
394
## Common Gotchas
395
395
396
-
1.**Kind `39000` for channel metadata, not `41`** — kind 41 is NIP-01 (unused). All kinds defined in `sprout-core/src/kind.rs`.
396
+
1.**Kind `39000` for channel metadata, not `41`** — kind 41 is NIP-01 (unused). All kinds defined in `buzz-core/src/kind.rs`.
397
397
2.**Relay queries must specify `kinds`** — omitting `kinds` triggers the p-gate (403). Always include explicit kind filters.
398
398
3.**`messages search` must include `--kinds`** — an open-ended search (no kinds) hits the relay p-gate and returns 403. Pass at least `--kinds 9,45001,45003` to scope the query.
399
399
4.**Worktrees: `cd` in the same command** — shell CWD doesn't persist between tool calls. Use `cd /path && cargo build` as one command.
0 commit comments