[CLI Flag Review] CLI Flag Consistency Report — 2026-06-01 #4142
Replies: 2 comments
-
|
🔮 The ancient spirits stir, and the smoke test agent has crossed the veil unscathed. The oracle foresees a passing build, a true title, and a quiet filesystem. Warning Firewall blocked 1 domainThe following domain was blocked by the firewall during workflow execution:
network:
allowed:
- defaults
- "registry.npmjs.org"See Network Configuration for more information.
|
Beta Was this translation helpful? Give feedback.
-
|
🔮 The ancient spirits stir; the smoke test agent has passed through this discussion and left its mark. Warning Firewall blocked 1 domainThe following domain was blocked by the firewall during workflow execution:
network:
allowed:
- defaults
- "registry.npmjs.org"See Network Configuration for more information.
|
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
-
📊 Summary
src/cli-options.tsOverall the documentation is well-maintained. Four flags are undocumented and there are minor description and short-form omissions.
✅ Flags Coverage (Condensed)
55 of 59 flags are consistently documented. The 4 exceptions:
usage.mdcli-reference.md--openai-api-auth-header--anthropic-api-auth-header--max-model-multiplier--docker-host-path-prefixShort forms also missing from
cli-reference.mdtable:-d(--allow-domains),-b(--build-local),-k(--keep-containers) — the same table shows-eand-vcorrectly.1.
--openai-api-auth-headerand--anthropic-api-auth-header— UndocumentedBoth flags are defined in
src/cli-options.tsbut absent fromdocs/usage.mdandcli-reference.md. They enable custom authentication schemes (Azure OpenAI, Databricks, etc.) — high-value flags with zero discoverability.Fix: Add entries to the API Proxy section of both files:
--openai-api-auth-header <name>— Custom auth header for OpenAI requests (default:Authorizationwith Bearer prefix)--anthropic-api-auth-header <name>— Custom auth header for Anthropic requests (default:x-api-key)2.
--max-model-multiplier— UndocumentedDefined in
src/cli-options.ts(lines 334–340) but absent from all user-facing docs. This is a meaningful cost-control feature for rate limiting by effective token spend.Fix: Add to the Rate Limiting section in both
usage.mdandcli-reference.md. Format: comma-separatedmodel:multiplierpairs, e.g.claude-opus-4-5-1m:10,claude-opus-4-5-200k:2.5. Requires--enable-api-proxy.3.
--docker-host-path-prefix— Missing fromcli-reference.mdPresent in
usage.mdandAGENTS.mdbut absent fromcli-reference.md(no table row, no detail section).--docker-hostis documented at table row 39;--docker-host-path-prefixis not.Fix: Add a table row alongside
--docker-hostand a### --docker-host-path-prefixdetail section near the ARC/DinD content.4. Short forms
-d,-b,-kmissing fromcli-reference.mdtableThree flags with short aliases show only their long form in the options summary table:
-d, --allow-domains--allow-domains-b, --build-local--build-local-k, --keep-containers--keep-containersCompare:
-e, --envand-v, --mountare shown correctly in the same table.Fix: Update the three table cells to include the short form.
5.
--enable-api-proxydescription stale insrc/cli-options.tsawf --helpshows: "Supports OpenAI (Codex) and Anthropic (Claude) APIs"The proxy also supports Copilot and Gemini (both have dedicated flags). The
--helpoutput is misleading.Fix: Change to: "Supports OpenAI, Anthropic, Copilot, and Gemini APIs."
6.
--dns-serversdefault inaccurate inAGENTS.mdAGENTS.mdstates: "Default: Google DNS (8.8.8.8,8.8.4.4)"The implementation auto-detects DNS from the host and only falls back to Google DNS.
cli-reference.mdcorrectly says "Auto-detected from host, falls back to8.8.8.8,8.8.4.4".Since
AGENTS.mdis read by AI coding agents, a wrong default can propagate into generated configs.Fix: Update to: "Default: Auto-detected from host; falls back to
8.8.8.8,8.8.4.4".📋 Prioritized Recommendations
High — undiscoverable features for users:
--openai-api-auth-headerand--anthropic-api-auth-headerinusage.md+cli-reference.md--max-model-multiplierin the Rate Limiting section of both filesMedium — reference doc completeness:
3. Add
--docker-host-path-prefixtocli-reference.mdtable + detail section4. Restore
-d,-b,-kshort forms incli-reference.mdtable5. Update
--enable-api-proxyhelp text insrc/cli-options.tsLow — agent instruction accuracy:
6. Fix
--dns-serversdefault description inAGENTS.md📁 Files Analyzed
src/cli-options.tsdocs/usage.mddocs-site/src/content/docs/reference/cli-reference.mdREADME.mdAGENTS.mdCLAUDE.mdBeta Was this translation helpful? Give feedback.
All reactions