Skip to content

cli.md

Latest commit

 

History

History
98 lines (65 loc) · 2.12 KB

cli.md

File metadata and controls

98 lines (65 loc) · 2.12 KB

CLI

bub currently exposes five builtin commands: run, gateway, chat, login, and the hidden compatibility command message.

bub run

Run one inbound message through the full framework pipeline and print outbounds.

uv run bub run "hello" --channel cli --chat-id local

Common options:

  • --workspace/-w: workspace root, declared once on the top-level CLI and shared by all subcommands
  • --channel: source channel (default cli)
  • --chat-id: source endpoint id (default local)
  • --sender-id: sender identity (default human)
  • --session-id: explicit session id (default is <channel>:<chat_id>)

Comma-prefixed input enters internal command mode:

uv run bub run ",help"
uv run bub run ",tools"
uv run bub run ",fs.read path=README.md"

Unknown comma commands fall back to shell execution:

uv run bub run ",echo hello-from-shell"

bub hooks

Print hook-to-plugin bindings discovered at startup.

uv run bub hooks

hooks remains available for diagnostics, but it is hidden from the top-level help.

bub gateway

Start channel listener mode (defaults to all non-cli channels).

uv run bub gateway

Enable only selected channels:

uv run bub gateway --enable-channel telegram

bub message is kept as a hidden compatibility alias and forwards to the same command implementation.

bub chat

Start an interactive REPL session via the cli channel.

uv run bub chat
uv run bub chat --chat-id local --session-id cli:local

bub login

Authenticate with OpenAI Codex OAuth and persist the resulting credentials under CODEX_HOME (default ~/.codex).

uv run bub login openai

Manual callback mode is useful when the local redirect server is unavailable:

uv run bub login openai --manual --no-browser

After login, you can use an OpenAI model without setting BUB_API_KEY:

BUB_MODEL=openai:gpt-5-codex uv run bub chat

Notes

  • --workspace is parsed before the subcommand, for example uv run bub --workspace /repo chat.
  • run prints each outbound as:
[channel:chat_id]
content