Skip to content

Commit 4cd5d8b

Browse files
committed
docs: minor update
Signed-off-by: Chojan Shang <psiace@apache.org>
1 parent 7115c5c commit 4cd5d8b

3 files changed

Lines changed: 22 additions & 16 deletions

File tree

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,10 @@ If `AGENTS.md` exists in the workspace, it is appended to the system prompt auto
5353

5454
Key source files:
5555

56-
- Turn orchestrator: [`src/bub/framework.py`](src/bub/framework.py)
57-
- Hook contract: [`src/bub/hookspecs.py`](src/bub/hookspecs.py)
58-
- Builtin hooks: [`src/bub/builtin/hook_impl.py`](src/bub/builtin/hook_impl.py)
59-
- Skill discovery: [`src/bub/skills.py`](src/bub/skills.py)
56+
- Turn orchestrator: [`src/bub/framework.py`](https://github.com/bubbuild/bub/blob/main/src/bub/framework.py)
57+
- Hook contract: [`src/bub/hookspecs.py`](https://github.com/bubbuild/bub/blob/main/src/bub/hookspecs.py)
58+
- Builtin hooks: [`src/bub/builtin/hook_impl.py`](https://github.com/bubbuild/bub/blob/main/src/bub/builtin/hook_impl.py)
59+
- Skill discovery: [`src/bub/skills.py`](https://github.com/bubbuild/bub/blob/main/src/bub/skills.py)
6060

6161
## What Sets It Apart
6262

@@ -109,7 +109,7 @@ Lines starting with `,` enter internal command mode (`,help`, `,skill name=my-sk
109109
| `BUB_API_KEY` || Provider key (optional with `bub login openai`) |
110110
| `BUB_API_BASE` || Custom provider endpoint |
111111
| `BUB_API_FORMAT` | `completion` | `completion`, `responses`, or `messages` |
112-
| `BUB_CLIENT_ARGS` | `{"extra_headers":{"HTTP-Referer":"https://bub.build/","X-Title":"Bub"}}` | JSON object forwarded to the underlying model client |
112+
| `BUB_CLIENT_ARGS` | | JSON object forwarded to the underlying model client |
113113
| `BUB_MAX_STEPS` | `50` | Max tool-use loop iterations |
114114
| `BUB_MAX_TOKENS` | `1024` | Max tokens per model call |
115115
| `BUB_MODEL_TIMEOUT_SECONDS` || Model call timeout (seconds) |
@@ -122,13 +122,13 @@ Read more: [Context from Tape](https://tape.systems) · [Socialized Evaluation a
122122

123123
## Docs
124124

125-
- [Architecture](docs/architecture.md) — lifecycle, hook precedence, error handling
126-
- [Features](docs/features.md) — what ships today and current boundaries
127-
- [Channels](docs/channels/index.md) — CLI, Telegram, and custom adapters
128-
- [Skills](docs/skills.md) — discovery and authoring
129-
- [Extension Guide](docs/extension-guide.md) — hooks, tools, plugin packaging
130-
- [Deployment](docs/deployment.md) — Docker, environment, upgrades
131-
- [Posts](docs/posts/index.md) — design notes
125+
- [Architecture](https://bub.build/architecture/) — lifecycle, hook precedence, error handling
126+
- [Features](https://bub.build/features/) — what ships today and current boundaries
127+
- [Channels](https://bub.build/channels/) — CLI, Telegram, and custom adapters
128+
- [Skills](https://bub.build/skills/) — discovery and authoring
129+
- [Extension Guide](https://bub.build/extension-guide/) — hooks, tools, plugin packaging
130+
- [Deployment](https://bub.build/deployment/) — Docker, environment, upgrades
131+
- [Posts](https://bub.build/posts/) — design notes
132132

133133
## Development
134134

@@ -138,8 +138,8 @@ uv run mypy src
138138
uv run pytest -q
139139
```
140140

141-
See [CONTRIBUTING.md](./CONTRIBUTING.md).
141+
See [CONTRIBUTING.md](https://github.com/bubbuild/bub/blob/main/CONTRIBUTING.md).
142142

143143
## License
144144

145-
[Apache-2.0](./LICENSE)
145+
[Apache-2.0](https://github.com/bubbuild/bub/blob/main/LICENSE)

docs/channels/cli.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,11 +87,11 @@ After login, you can use an OpenAI model without setting `BUB_API_KEY`:
8787
BUB_MODEL=openai:gpt-5-codex uv run bub chat
8888
```
8989

90-
If the upstream endpoint expects a specific OpenAI-compatible request shape, set `BUB_API_FORMAT`:
90+
If the upstream endpoint expects a specific request payload format, set `BUB_API_FORMAT`:
9191

9292
- `completion`: legacy completion-style format; default
9393
- `responses`: OpenAI Responses API format
94-
- `messages`: chat-completions-style messages format
94+
- `messages`: Anthropic Messages API format
9595

9696
```bash
9797
BUB_MODEL=openai:gpt-5-codex BUB_API_FORMAT=responses uv run bub chat

docs/deployment.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,12 @@ BUB_MODEL=openrouter:qwen/qwen3-coder-next
2424
OPENROUTER_API_KEY=sk-or-...
2525
```
2626

27+
Advanced model-client settings:
28+
29+
- `BUB_API_FORMAT` selects the request payload format sent to the upstream model endpoint: `completion`, `responses`, or `messages`.
30+
- `BUB_CLIENT_ARGS` passes a JSON object through to the underlying model client.
31+
- The accepted `BUB_CLIENT_ARGS` keys depend on the selected provider and downstream SDK behavior, so treat it as an escape hatch rather than a stable cross-provider interface.
32+
2733
## 2) Runtime Modes
2834

2935
Choose one command based on your operation target:

0 commit comments

Comments
 (0)