Skip to content

docs(buzz-acp): correct agent key generation instructions#2875

Merged
wpfleger96 merged 1 commit into
block:mainfrom
mager:fix-acp-readme-keygen
Jul 25, 2026
Merged

docs(buzz-acp): correct agent key generation instructions#2875
wpfleger96 merged 1 commit into
block:mainfrom
mager:fix-acp-readme-keygen

Conversation

@mager

@mager mager commented Jul 25, 2026

Copy link
Copy Markdown
Contributor

Problem

crates/buzz-acp/README.md tells you to generate an agent identity with:

cargo run -p buzz-admin -- mint-token --name "my-agent" --scopes "messages:read,messages:write,channels:read"

mint-token is not a subcommand of buzz-admin — the available commands are
add-member, remove-member, list-members, generate-key, migrate,
product-feedback, and reconcile-channels. Following the agent quickstart
fails at the first step.

Change

Documents the flow that works:

  1. generate-key to mint the keypair
  2. add-member to register the agent's pubkey on the relay

Also notes that add-member publishes a kind:13534 membership event and so
requires BUZZ_RELAY_PRIVATE_KEY to be set on the relay. It is commented out
in .env.example, and the relay must be restarted after setting it — the
error surfaces at add-member time rather than at relay startup, so it is
easy to hit.

Corrects the described output as well: generate-key prints a hex keypair,
not an nsec1... key plus an API token.

Verification

Found while setting up a self-hosted relay and wiring an agent through
buzz-acp with claude-agent-acp. Both documented commands were run against
a local relay; the agent authenticates and round-trips signed messages.

Docs only — no code paths touched.

🤖 Generated with Claude Code

@mager
mager requested a review from a team as a code owner July 25, 2026 18:46

@wpfleger96 wpfleger96 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the contribution! Your commit just needs a DCO sign-off then this can merge!

The README instructs `buzz-admin mint-token --name --scopes`, which is not
a subcommand of buzz-admin. Following the quickstart fails at the first
step of setting up an agent identity.

Replace it with the actual flow: `generate-key` to mint the keypair, then
`add-member` to register the agent's pubkey on the relay. Also note that
`add-member` publishes a kind:13534 event and therefore requires
BUZZ_RELAY_PRIVATE_KEY to be set on the relay, which is commented out in
.env.example by default and is easy to miss.

Also corrects the described output: `generate-key` prints a hex keypair,
not an `nsec1...` key plus an API token.

Signed-off-by: mager <andrew.mager@gmail.com>
@mager
mager force-pushed the fix-acp-readme-keygen branch from 82661f0 to 79ddae1 Compare July 25, 2026 20:51
@mager

mager commented Jul 25, 2026

Copy link
Copy Markdown
Contributor Author

@wpfleger96 Thanks! DCO check is passing now, will merge when all green.

@mager

mager commented Jul 25, 2026

Copy link
Copy Markdown
Contributor Author

All green now — DCO passing and CI clean. I don't have merge rights here, so this needs a maintainer to land it whenever convenient.

@wpfleger96
wpfleger96 merged commit c7089d3 into block:main Jul 25, 2026
32 checks passed
johnmatthewtennant added a commit to johnmatthewtennant/buzz that referenced this pull request Jul 26, 2026
…unity-policy-fetch

* origin/main:
  Fix formatting in README.md diagram (block#2284)
  fix(desktop): make Linux AppImage GStreamer work on non-Debian distros (block#2176)
  refactor(desktop): remove Agent directory section from Agents page (block#2290)
  fix(desktop): enable arboard Wayland backend so Linux copies reach the Wayland clipboard (block#2904)
  fix(desktop): supervise and re-arm relay-mesh runtime (block#2823)
  fix(agents): run live Databricks discovery instead of the fallback list (block#2890)
  fix(desktop): retire prepend mode on every reader wheel (block#2913)
  fix(desktop): consolidate prepend scroll correction (block#2855)
  docs(buzz-acp): correct agent key generation instructions (block#2875)
  fix(desktop): track concurrent agent turns up to the harness maximum (block#2882)
  docs(contributing): trim to goose-scale minimal intake surface (block#2780)
  fix(relay): preserve reconnect backoff (block#2759)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants