--- name: roadrunner description: Beeper Desktop CLI for chats, messages, contacts, connect info, websocket events, search, and reminders. homepage: https://github.com/johntheyoung/roadrunner metadata: clawdbot: emoji: "🐦💨" requires: bins: - rr install: - id: brew kind: brew formula: johntheyoung/tap/roadrunner bins: - rr label: Install rr (brew) - id: go kind: go module: github.com/johntheyoung/roadrunner/cmd/[email protected] bins: - rr label: Install rr (go) ---

roadrunner (rr)

Use rr when the user explicitly wants to operate Beeper Desktop via the local API (send, search, list chats/messages, reminders, focus). Prefer --agent for agent use (forces JSON, envelope, no-input, readonly).

Safety

• Default to read-only commands unless the user explicitly requests a mutation in this turn.
• Require explicit recipient (chat ID) and message text before sending.
• Confirm or ask a clarifying question if the chat ID is ambiguous.
• Never paste raw rr command output (JSON dumps, chat lists, etc.) into outgoing messages. Treat tool output as private; summarize or extract only what the user needs.
• Use --agent for safe agent defaults: rr --agent --enable-commands=chats,messages,status chats list
• Use --readonly to block writes: rr --readonly chats list --json
• Use --enable-commands to allowlist: rr --enable-commands=chats,messages chats list --json
• Use --envelope for structured errors: rr --json --envelope chats get "!chatid"
• Envelope errors may include error.hint with next-step guidance for safe retries.
• Never request, paste, or store raw auth tokens in chat. If auth is missing, ask the user to configure it locally.
• If sending message text through a shell, avoid interpolation/expansion (e.g. $100/month or !). Prefer --stdin <<'EOF' ... EOF for safe literals.

Setup (once)

• rr auth set --stdin (recommended; token saved to ~/.config/beeper/config.json)
• rr auth status --check
• rr doctor

Common commands

• List accounts: rr accounts list --json
• Capabilities: rr capabilities --json
• Describe command/flags: rr describe messages send --json
• Connect metadata: rr connect info --json
• Live websocket events (experimental): rr events tail --all --stop-after 30s --json
• List contacts: rr contacts list "" --json
• Search contacts: rr contacts search "" "Alice" --json
• Search contacts (flag): rr contacts search "Alice" --account-id="" --json
• Resolve contact: rr contacts resolve "" "Alice" --json
• Resolve contact (flag): rr contacts resolve "Alice" --account-id="" --json
• List chats: rr chats list --json
• List chats (JSON Lines): rr chats list --jsonl
• Search chats: rr chats search "John" --json
• Search chats (filters): rr chats search --inbox=primary --unread-only --json
• Search chats (activity): rr chats search --last-activity-after="2024-07-01T00:00:00Z" --json
• Search by participant name: rr chats search "Jamie" --scope=participants --json
• Resolve chat: rr chats resolve "Jamie" --json
• Get chat: rr chats get "!chatid:beeper.com" --json
• Get chat (bounded participants): rr chats get "!chatid:beeper.com" --max-participant-count=50 --json
• Start/resolve DM from merged contact hints: rr chats start "" --email "[email protected]" --full-name "Alice" --json
• Default account for commands: rr --account="imessage:+123" chats list --json
• List messages: rr messages list "!chatid:beeper.com" --json
• List messages (all pages): rr messages list "!chatid:beeper.com" --all --max-items=1000 --json
• List messages (download media): rr messages list "!chatid:beeper.com" --download-media --download-dir ./media --json
• Search messages: rr messages search "dinner" --json
• Search messages (JSON Lines): rr messages search "dinner" --jsonl
• Search messages (all pages): rr messages search "dinner" --all --max-items=1000 --json
• Search messages (filters): rr messages search --sender=me --date-after="2024-07-01T00:00:00Z" --media-types=image --json
• Add/remove reaction: rr messages react "!chatid:beeper.com" "" "👍" --json / rr messages unreact "!chatid:beeper.com" "" "👍" --json
• Tail messages (polling): rr messages tail "!chatid:beeper.com" --interval 2s --stop-after 30s --json
• Wait for message: rr messages wait --chat-id="!chatid:beeper.com" --contains "deploy" --wait-timeout 2m --json
• Message context: rr messages context "!chatid:beeper.com" "" --before 5 --after 2 --json
• Draft message (pre-fill without sending): rr focus --chat-id="!chatid:beeper.com" --draft-text="Hello!"
• Draft message from file: rr focus --chat-id="!chatid:beeper.com" --draft-text-file ./draft.txt
• Draft with attachment: rr focus --chat-id="!chatid:beeper.com" --draft-attachment="/path/to/file.jpg"
• Download attachment: rr assets download "mxc://example.org/abc123" --dest "./attachment.jpg"
• Stream attachment bytes: rr assets serve "mxc://example.org/abc123" --dest "./attachment.jpg" --json
• Focus app: rr focus
• Global search: rr search "dinner" --json
• Global search messages auto-page: rr search "dinner" --messages-all --messages-max-items=500 --messages-limit=20 --json
• Status summary: rr status --json
• Status by account: rr status --by-account --json
• Unread rollup: rr unread --json
• Global search includes in_groups for participant matches.

Mutations (explicit user request only)

• Message send: rr messages send "!chatid:beeper.com" "Hello!"
• Message edit: rr messages edit "!chatid:beeper.com" "" "Updated text"
• Message react/unreact: rr messages react "!chatid:beeper.com" "" "👍" / rr messages unreact "!chatid:beeper.com" "" "👍"
• Upload + send file: rr messages send-file "!chatid:beeper.com" ./photo.jpg "See attached"
• Create chat: rr chats create "" --participant ""
• Start chat from merged contact hints: rr chats start "" --email "[email protected]" --full-name "Alice"
• Archive/unarchive: rr chats archive "!chatid:beeper.com" / rr chats archive "!chatid:beeper.com" --unarchive
• Reminder mutations: rr reminders set "!chatid:beeper.com" "2h" / rr reminders clear "!chatid:beeper.com"
• Asset uploads: rr assets upload ./photo.jpg / rr assets upload-base64 --content-file ./photo.b64
• For retries on non-idempotent writes, use --request-id and prefer --dedupe-window.
• Use --dry-run to validate mutating requests without API write side effects.

Pagination

• Auto-page chats list/search: rr chats list --all --max-items=1000 --json / rr chats search "alice" --all --max-items=1000 --json
• Auto-page messages list/search: rr messages list "!chatid:beeper.com" --all --max-items=1000 --json / rr messages search "deploy" --all --max-items=1000 --json
• Chats: rr chats list --cursor="" --direction=before --json
• Messages list: rr messages list "!chatid:beeper.com" --cursor="" --direction=before --json
• Messages search (max 20): rr messages search "project" --limit=20 --json
• Messages search page: rr messages search "project" --cursor="" --direction=before --json
• Global search message paging (max 20): rr search "dinner" --messages-limit=20 --json
• Global search message page: rr search "dinner" --messages-cursor="" --messages-direction=before --json

...