docs: update sprout repository references and document buzz mem (#1333)

Signed-off-by: Aaron Goldsmith <aargoldsmith@gmail.com>
This commit is contained in:
Aaron Goldsmith
2026-06-28 07:53:03 -07:00
committed by GitHub
parent 744c77bc2d
commit 52b6365e17
4 changed files with 25 additions and 12 deletions

View File

@@ -8,18 +8,18 @@ code style, PR process, architecture), see [CONTRIBUTING.md](CONTRIBUTING.md).
## Ecosystem
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:
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:
| Repo | Purpose |
|------|---------|
| [block/sprout](https://github.com/block/sprout) | OSS source — relay, desktop app, mobile app, CLI, agent harness |
| [block/buzz](https://github.com/block/buzz) | OSS source — relay, desktop app, mobile app, CLI, agent harness |
| [squareup/sprout-releases](https://github.com/squareup/sprout-releases) | Buildkite pipeline producing Block-signed macOS + iOS builds with `-block` version suffix |
| [squareup/sprout-oss](https://github.com/squareup/sprout-oss) | CI pipeline building the relay Docker image and pushing to internal ECR |
| [squareup/block-coder-tf-stacks](https://github.com/squareup/block-coder-tf-stacks) | Terraform + ArgoCD deploying the relay to the staging Kubernetes cluster |
| [squareup/sprout-backend-blox](https://github.com/squareup/sprout-backend-blox) | Desktop backend provider script connecting Blox workstation agents to the relay |
```
block/sprout (source)
block/buzz (source)
├─► sprout-releases (desktop + mobile builds → Artifactory, GitHub, Mobile Releases)
├─► sprout-oss (relay Docker image → ECR)
│ └─► 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:
```bash
# List screenshot comments to find the stale one's id
gh pr view <pr> --repo block/sprout --json comments \
gh pr view <pr> --repo block/buzz --json comments \
--jq '.comments[] | select(.body | test("pr-<pr>--")) | {id, url}'
gh api -X DELETE repos/block/sprout/issues/comments/<stale-comment-id>
gh api -X DELETE repos/block/buzz/issues/comments/<stale-comment-id>
```
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.
**PR comments:** Use a body template (3rd arg to `post-screenshots.sh`) with
`{{filename}}` placeholders. Each screenshot gets a `###` heading + one-line
description. See [PR #803](https://github.com/block/sprout/pull/803).
description. See [PR #803](https://github.com/block/buzz/pull/803).
---

View File

@@ -65,8 +65,8 @@ versions in the table above.
```bash
# 1. Clone the repo
git clone https://github.com/block/sprout.git
cd sprout
git clone https://github.com/block/buzz.git
cd buzz
# 2. Activate Hermit (optional but recommended)
. ./bin/activate-hermit
@@ -311,7 +311,7 @@ to existing clients.
## Ecosystem
Buzz is developed across multiple repositories. This repo (`block/sprout`)
Buzz is developed across multiple repositories. This repo (`block/buzz`)
is the open-source home for all application code — the relay, desktop app,
mobile app, CLI, and agent harness. Internal repositories handle
enterprise-signed builds and infrastructure deployment.
@@ -319,7 +319,7 @@ enterprise-signed builds and infrastructure deployment.
See [AGENTS.md § Ecosystem](AGENTS.md#ecosystem) for the full repo table and
dependency diagram.
**External contributors:** Fork `block/sprout`, open a PR, and CI runs
**External contributors:** Fork `block/buzz`, open a PR, and CI runs
automatically. No special access is required.
**Block team members:** See the internal

View File

@@ -115,7 +115,7 @@ You'll need [Docker](https://docs.docker.com/get-docker/) and [Hermit](https://c
**Once:**
```bash
git clone https://github.com/block/sprout.git && cd sprout
git clone https://github.com/block/buzz.git && cd buzz
. ./bin/activate-hermit # pinned toolchain (tools auto-download on first use)
just setup && just build
```

View File

@@ -74,11 +74,18 @@ buzz messages vote --event <event-id> --direction up
buzz canvas get --channel <uuid>
buzz canvas set --channel <uuid> --content "# Welcome"
# Agent Memory (NIP-AE)
buzz mem ls
buzz mem get <slug>
buzz mem set <slug> "my-value"
buzz mem patch <slug> --base-hash <hex> < diff.patch # or --no-base-hash
buzz mem rm <slug>
# Pipe to jq
buzz channels list | jq '.[].name'
```
## 54 Subcommands across 12 Groups
## 60 Subcommands across 13 Groups
| Group | Subcommand | Description |
|-------|-----------|-------------|
@@ -136,6 +143,12 @@ buzz channels list | jq '.[].name'
| `upload` | `file` | Upload a file to the Blossom store |
| `pack` | `validate` | Validate a persona pack (local, no relay) |
| | `inspect` | Inspect a persona pack (local, no relay) |
| `mem` | `ls` | List non-tombstoned memories |
| | `get` | Print memory value to stdout |
| | `hash` | Print SHA-256 hex of memory value |
| | `set` | Write a memory value (use `-` for stdin) |
| | `patch` | Apply unified diff to memory value |
| | `rm` | Publish a tombstone to delete memory |
## Architecture