docs: sync version references and add missing CLI flags#1223
docs: sync version references and add missing CLI flags#1223
Conversation
- Update Docker image examples from v0.13.0 to latest tag in usage.md - Add dedicated --enable-api-proxy section with examples and link to api-proxy-sidecar.md Note: --allow-full-filesystem-access flag referenced in #836 does not exist in the codebase and was not documented. quickstart.md version was already at 0.18.0 (newer than the 0.16.2 target), so no change needed. Closes #836 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Updates end-user documentation to better reflect current CLI capabilities and recommended image-tag usage, focusing on the API proxy sidecar and Docker image version examples.
Changes:
- Added a new
--enable-api-proxy“API Proxy Sidecar” section with usage and rate-limiting examples and a link toapi-proxy-sidecar.md. - Updated pre-download Docker image examples from
v0.13.0to:latest, and added an example for pinning tov0.16.2.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| When enabled, the proxy: | ||
| - Isolates API keys from the agent container (keys never enter the agent environment) | ||
| - Automatically injects Bearer tokens for OpenAI and Anthropic APIs |
There was a problem hiding this comment.
The bullet says the proxy "injects Bearer tokens for OpenAI and Anthropic APIs", but the Anthropic proxy actually authenticates via the x-api-key header (and only OpenAI/Copilot use Authorization: Bearer ...). This line should be corrected to avoid misleading users about which headers are injected for each provider.
| - Automatically injects Bearer tokens for OpenAI and Anthropic APIs | |
| - Automatically injects the correct authentication headers (Authorization: Bearer for OpenAI/Copilot, x-api-key for Anthropic) |
| @@ -602,12 +631,16 @@ sudo awf --skip-pull --allow-domains github.com -- your-command | |||
| **Using Specific Versions:** | |||
| ```bash | |||
| # Pre-download specific version | |||
There was a problem hiding this comment.
In the "Using Specific Versions" snippet, the comment "Pre-download specific version" conflicts with the commands immediately below, which pull :latest. Either change the comment to reflect pulling latest, or change these pulls to a pinned vX.Y.Z to match the section intent.
| # Pre-download specific version | |
| # Pre-download latest images |
|
Smoke Test Results (run 22932264173) ✅ GitHub MCP — #1160 fix(squid): block direct IP connections, #1099 feat: add skip-cleanup flag Overall: PASS
|
|
Smoke Test Results — Run #22932264181
Overall: PASS · PR by
|
|
PR Titles: docs: sync version references and add missing CLI flags | test: add --skip-pull integration test
|
🏗️ Build Test Suite Results
Overall: 8/8 ecosystems passed — ✅ PASS
|
Summary
v0.13.0tolatesttag indocs/usage.md--enable-api-proxysection indocs/usage.mdwith usage examples, rate limiting examples, and a link toapi-proxy-sidecar.mdNotes on issue scope:
docs/quickstart.mdversion was already at0.18.0(newer than the0.16.2target in [docs] sync version references and add missing CLI flags #836), so no change was needed--allow-full-filesystem-accessflag referenced in [docs] sync version references and add missing CLI flags #836 does not exist in the codebase (src/cli.ts), so it was not documented. This may need a separate issue to either add the flag or remove it from the tracking issue.Closes #836
Test plan
npm run buildpassesnpm testpassesnpm run lintpasses🤖 Generated with Claude Code