Skip to content

docs: sync version references and add missing CLI flags#1223

Open
Mossaka wants to merge 1 commit intomainfrom
fix/039-docs-sync-versions
Open

docs: sync version references and add missing CLI flags#1223
Mossaka wants to merge 1 commit intomainfrom
fix/039-docs-sync-versions

Conversation

@Mossaka
Copy link
Collaborator

@Mossaka Mossaka commented Mar 11, 2026

Summary

  • Updated Docker image examples from v0.13.0 to latest tag in docs/usage.md
  • Added dedicated --enable-api-proxy section in docs/usage.md with usage examples, rate limiting examples, and a link to api-proxy-sidecar.md

Notes on issue scope:

Closes #836

Test plan

  • npm run build passes
  • npm test passes
  • npm run lint passes
  • Changes are docs-only, no code changes

🤖 Generated with Claude Code

- 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>
Copilot AI review requested due to automatic review settings March 11, 2026 01:29
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 to api-proxy-sidecar.md.
  • Updated pre-download Docker image examples from v0.13.0 to :latest, and added an example for pinning to v0.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
Copy link

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
- 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)

Copilot uses AI. Check for mistakes.
@@ -602,12 +631,16 @@ sudo awf --skip-pull --allow-domains github.com -- your-command
**Using Specific Versions:**
```bash
# Pre-download specific version
Copy link

Copilot AI Mar 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
# Pre-download specific version
# Pre-download latest images

Copilot uses AI. Check for mistakes.
@github-actions
Copy link
Contributor

Smoke Test Results (run 22932264173)

✅ GitHub MCP — #1160 fix(squid): block direct IP connections, #1099 feat: add skip-cleanup flag
✅ Playwright — github.com title verified ("GitHub · Change is constant...")
✅ File write — /tmp/gh-aw/agent/smoke-test-claude-22932264173.txt created
✅ Bash — file contents confirmed

Overall: PASS

💥 [THE END] — Illustrated by Smoke Claude for issue #1223

@github-actions
Copy link
Contributor

Smoke Test Results — Run #22932264181

Test Result
GitHub MCP (last 2 merged PRs) #1160 "fix(squid): block direct IP connections that bypass domain filtering" · #1157 "feat: combine all build-test workflows into single build-test.md"
Playwright (github.com title contains "GitHub")
File write (smoke-test-copilot-22932264181.txt)
Bash verify (cat file)

Overall: PASS · PR by @Mossaka · no assignees

📰 BREAKING: Report filed by Smoke Copilot for issue #1223

@github-actions
Copy link
Contributor

PR Titles: docs: sync version references and add missing CLI flags | test: add --skip-pull integration test
GitHub MCP merged PR review: ✅
Safeinputs gh PR list: ✅
Playwright title check: ✅
Tavily search: ❌ (Tavily MCP tool unavailable)
File write: ✅
Bash cat verify: ✅
Discussion query+comment: ✅
Build npm ci && npm run build: ✅
Overall: FAIL

🔮 The oracle has spoken through Smoke Codex for issue #1223

@github-actions
Copy link
Contributor

🏗️ Build Test Suite Results

Ecosystem Project Build/Install Tests Status
Bun elysia 1/1 passed ✅ PASS
Bun hono 1/1 passed ✅ PASS
C++ fmt N/A ✅ PASS
C++ json N/A ✅ PASS
Deno oak N/A 1/1 passed ✅ PASS
Deno std N/A 1/1 passed ✅ PASS
.NET hello-world N/A ✅ PASS
.NET json-parse N/A ✅ PASS
Go color 1/1 passed ✅ PASS
Go env 1/1 passed ✅ PASS
Go uuid 1/1 passed ✅ PASS
Java gson 1/1 passed ✅ PASS
Java caffeine 1/1 passed ✅ PASS
Node.js clsx All passed ✅ PASS
Node.js execa All passed ✅ PASS
Node.js p-limit All passed ✅ PASS
Rust fd 1/1 passed ✅ PASS
Rust zoxide 1/1 passed ✅ PASS

Overall: 8/8 ecosystems passed — ✅ PASS

Generated by Build Test Suite for issue #1223 ·

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[docs] sync version references and add missing CLI flags

2 participants