mirror of
https://github.com/block/buzz.git
synced 2026-11-02 07:22:55 +00:00
de40dc85c5
- examples/mock_broker.rs: a throwaway host that speaks just enough of the contract (POST /v1/action, echoes requestId/action, canned outcomes) to exercise the keyless CLI end to end before a real broker exists. Signs nothing, touches no relay. - KEYLESS.md: brief instructions — build, run against the mock, and point the CLI at your own broker. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Signed-off-by: Joel Robotham <jrobotham@squareup.com>
73 lines
2.4 KiB
Markdown
73 lines
2.4 KiB
Markdown
# Keyless mode (agent broker client)
|
|
|
|
Run the `buzz` CLI without a signing key. In keyless mode the CLI holds no nsec
|
|
and opens no relay connection — every operation is sent to a **broker host** that
|
|
performs it on the agent's behalf. This is the client side of the agent-broker
|
|
contract ([#6790](https://github.com/block/buzz/pull/6790)).
|
|
|
|
The backend is selected by `--agent-mode` (env `BUZZ_AGENT_MODE`), default
|
|
`local`:
|
|
|
|
- `local` — hold the key, sign locally, talk to the relay (the unchanged default).
|
|
- `broker` — keyless; route every operation through a broker host.
|
|
|
|
This first slice covers the wake→reply loop: `messages get` (with
|
|
`--mentions-only`, the wake path) and `messages send` / reply.
|
|
|
|
## Build
|
|
|
|
```sh
|
|
source bin/activate-hermit
|
|
cargo build -p buzz-cli --bin buzz --example mock_broker
|
|
```
|
|
|
|
## Try it against the bundled mock host
|
|
|
|
The repo ships a throwaway mock host so you can exercise the round trip without a
|
|
real broker. It signs nothing and returns canned outcomes — it exists only to
|
|
prove the client wiring end to end.
|
|
|
|
Terminal 1 — the mock host:
|
|
|
|
```sh
|
|
cargo run -p buzz-cli --example mock_broker
|
|
# listening on http://127.0.0.1:8787
|
|
```
|
|
|
|
Terminal 2 — the keyless client (note: no key in the environment):
|
|
|
|
```sh
|
|
export BUZZ_AGENT_MODE=broker
|
|
export BUZZ_BROKER_URL=http://127.0.0.1:8787
|
|
export BUZZ_BROKER_CREDENTIAL=dev-token
|
|
unset BUZZ_PRIVATE_KEY
|
|
|
|
CH=<channel-uuid>
|
|
buzz messages send --channel "$CH" --content "hello from a keyless client"
|
|
buzz messages send --channel "$CH" --reply-to <event-id> --content "on it"
|
|
buzz messages get --channel "$CH" --mentions-only --limit 10
|
|
```
|
|
|
|
Terminal 1 logs each action, the bearer credential, and the args it received.
|
|
|
|
## Point it at your own broker
|
|
|
|
Swap the two broker vars for your host's endpoint and a credential it issued:
|
|
|
|
```sh
|
|
export BUZZ_BROKER_URL=https://your-broker.example
|
|
export BUZZ_BROKER_CREDENTIAL=<token your broker accepts>
|
|
```
|
|
|
|
Your host must accept `POST /v1/action` with `Authorization: Bearer <credential>`
|
|
and return a broker-result envelope per the contract. `examples/mock_broker.rs`
|
|
is a minimal reference for the wire shape.
|
|
|
|
## Notes
|
|
|
|
- Keyless mode **fails closed** if a private key is present (`--private-key` /
|
|
`BUZZ_PRIVATE_KEY`): supplying a key in broker mode is a provisioning error,
|
|
not silently ignored.
|
|
- Credential issuance, authorization, and custody are the host's concern; the
|
|
client only needs an endpoint and a token to present.
|