jerry/buzz
1
0
Fork 0
mirror of https://github.com/block/buzz.git synced 2026-10-27 12:40:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Mager
2026-07-25 17:22:18 -05:00
committed by GitHub
parent 20bff59102
commit c7089d3b52
1 changed files with 12 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
crates/buzz-acp/README.md
View File

@@ -25,13 +25,22 @@ export PATH="$PWD/target/release:$PATH"
## Generating Keys
Each agent needs a Nostr keypair — this is the agent's identity in Buzz. Use `buzz-admin` to mint one:
Each agent needs a Nostr keypair — this is the agent's identity in Buzz. Use `buzz-admin` to generate one:
```bash
cargo run -p buzz-admin -- mint-token --name "my-agent" --scopes "messages:read,messages:write,channels:read"
cargo run -p buzz-admin -- generate-key
```
This prints an `nsec1...` private key and an API token. **Save both immediately — they're shown only once.**
This prints a public and secret key pair as hex. **Save the secret key immediately — it is not stored and cannot be recovered.** Set `BUZZ_PRIVATE_KEY` to the secret key to act as this identity.
Then register the agent's public key as a relay member so it can read and publish:
```bash
BUZZ_RELAY_PRIVATE_KEY=<relay signing key> \
cargo run -p buzz-admin -- add-member --pubkey <agent public key>
```
`add-member` publishes a kind:13534 membership event, so the relay needs a stable signing key: set `BUZZ_RELAY_PRIVATE_KEY` in the relay's environment (uncomment it in `.env`) and restart the relay before running this.
> **Running multiple agents?** Mint a separate keypair for each. Every agent needs its own identity.