Skip to content

Commit 52b6365

Browse files
docs: update sprout repository references and document buzz mem (#1333)
Signed-off-by: Aaron Goldsmith <[email protected]>
1 parent 744c77b commit 52b6365

4 files changed

Lines changed: 25 additions & 12 deletions

File tree

‎AGENTS.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,18 @@ code style, PR process, architecture), see [CONTRIBUTING.md](CONTRIBUTING.md).
88

99
## Ecosystem
1010

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:
11+
Buzz spans five repos. This one (`block/buzz`) is the OSS source for the relay, desktop, mobile, and CLI. The others handle internal builds and deployment:
1212

1313
| Repo | Purpose |
1414
|------|---------|
15-
| [block/sprout](https://github.com/block/sprout) | OSS source — relay, desktop app, mobile app, CLI, agent harness |
15+
| [block/buzz](https://github.com/block/buzz) | OSS source — relay, desktop app, mobile app, CLI, agent harness |
1616
| [squareup/sprout-releases](https://github.com/squareup/sprout-releases) | Buildkite pipeline producing Block-signed macOS + iOS builds with `-block` version suffix |
1717
| [squareup/sprout-oss](https://github.com/squareup/sprout-oss) | CI pipeline building the relay Docker image and pushing to internal ECR |
1818
| [squareup/block-coder-tf-stacks](https://github.com/squareup/block-coder-tf-stacks) | Terraform + ArgoCD deploying the relay to the staging Kubernetes cluster |
1919
| [squareup/sprout-backend-blox](https://github.com/squareup/sprout-backend-blox) | Desktop backend provider script connecting Blox workstation agents to the relay |
2020

2121
```
22-
block/sprout (source)
22+
block/buzz (source)
2323
├─► sprout-releases (desktop + mobile builds → Artifactory, GitHub, Mobile Releases)
2424
├─► sprout-oss (relay Docker image → ECR)
2525
│ └─► block-coder-tf-stacks (Helm chart → ArgoCD → staging cluster)
@@ -331,9 +331,9 @@ only the current set remains, otherwise reviewers still see the stale images:
331331

332332
```bash
333333
# List screenshot comments to find the stale one's id
334-
gh pr view <pr> --repo block/sprout --json comments \
334+
gh pr view <pr> --repo block/buzz --json comments \
335335
--jq '.comments[] | select(.body | test("pr-<pr>--")) | {id, url}'
336-
gh api -X DELETE repos/block/sprout/issues/comments/<stale-comment-id>
336+
gh api -X DELETE repos/block/buzz/issues/comments/<stale-comment-id>
337337
```
338338

339339
Branch cleanup when fully done: `git push origin --delete agent-screenshots/<username>`.
@@ -407,7 +407,7 @@ not post. This catches the most common screenshot regression.
407407

408408
**PR comments:** Use a body template (3rd arg to `post-screenshots.sh`) with
409409
`{{filename}}` placeholders. Each screenshot gets a `###` heading + one-line
410-
description. See [PR #803](https://github.com/block/sprout/pull/803).
410+
description. See [PR #803](https://github.com/block/buzz/pull/803).
411411

412412
---
413413

‎CONTRIBUTING.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,8 @@ versions in the table above.
6565

6666
```bash
6767
# 1. Clone the repo
68-
git clone https://github.com/block/sprout.git
69-
cd sprout
68+
git clone https://github.com/block/buzz.git
69+
cd buzz
7070

7171
# 2. Activate Hermit (optional but recommended)
7272
. ./bin/activate-hermit
@@ -311,15 +311,15 @@ to existing clients.
311311

312312
## Ecosystem
313313

314-
Buzz is developed across multiple repositories. This repo (`block/sprout`)
314+
Buzz is developed across multiple repositories. This repo (`block/buzz`)
315315
is the open-source home for all application code — the relay, desktop app,
316316
mobile app, CLI, and agent harness. Internal repositories handle
317317
enterprise-signed builds and infrastructure deployment.
318318

319319
See [AGENTS.md § Ecosystem](AGENTS.md#ecosystem) for the full repo table and
320320
dependency diagram.
321321

322-
**External contributors:** Fork `block/sprout`, open a PR, and CI runs
322+
**External contributors:** Fork `block/buzz`, open a PR, and CI runs
323323
automatically. No special access is required.
324324

325325
**Block team members:** See the internal

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ You'll need [Docker](https://docs.docker.com/get-docker/) and [Hermit](https://c
115115

116116
**Once:**
117117
```bash
118-
git clone https://github.com/block/sprout.git && cd sprout
118+
git clone https://github.com/block/buzz.git && cd buzz
119119
. ./bin/activate-hermit # pinned toolchain (tools auto-download on first use)
120120
just setup && just build
121121
```

‎crates/buzz-cli/README.md‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,11 +74,18 @@ buzz messages vote --event <event-id> --direction up
7474
buzz canvas get --channel <uuid>
7575
buzz canvas set --channel <uuid> --content "# Welcome"
7676

77+
# Agent Memory (NIP-AE)
78+
buzz mem ls
79+
buzz mem get <slug>
80+
buzz mem set <slug> "my-value"
81+
buzz mem patch <slug> --base-hash <hex> < diff.patch # or --no-base-hash
82+
buzz mem rm <slug>
83+
7784
# Pipe to jq
7885
buzz channels list | jq '.[].name'
7986
```
8087

81-
## 54 Subcommands across 12 Groups
88+
## 60 Subcommands across 13 Groups
8289

8390
| Group | Subcommand | Description |
8491
|-------|-----------|-------------|
@@ -136,6 +143,12 @@ buzz channels list | jq '.[].name'
136143
| `upload` | `file` | Upload a file to the Blossom store |
137144
| `pack` | `validate` | Validate a persona pack (local, no relay) |
138145
| | `inspect` | Inspect a persona pack (local, no relay) |
146+
| `mem` | `ls` | List non-tombstoned memories |
147+
| | `get` | Print memory value to stdout |
148+
| | `hash` | Print SHA-256 hex of memory value |
149+
| | `set` | Write a memory value (use `-` for stdin) |
150+
| | `patch` | Apply unified diff to memory value |
151+
| | `rm` | Publish a tombstone to delete memory |
139152

140153
## Architecture
141154

0 commit comments

Comments
 (0)