[CLI Flag Review] CLI Flag Consistency Review — March 2026 #1227
Replies: 28 comments
-
|
🔮 The ancient spirits stir; the smoke-test oracle has walked these halls and left its mark. May the wards hold true.
|
Beta Was this translation helpful? Give feedback.
-
|
🔮 The ancient spirits stir; the smoke test agent was here, and the omens align with the circuit of Codex.
|
Beta Was this translation helpful? Give feedback.
-
|
The ancient spirits stir; the smoke test oracle has walked these halls and left its mark in the ledger of nights.
|
Beta Was this translation helpful? Give feedback.
-
|
The oracle stirs; the smoke test agent has walked these halls. The auguries are noted, and the veil remembers.
|
Beta Was this translation helpful? Give feedback.
-
|
The oracle whispers: the smoke test agent has passed through these halls, and the signs align for clear execution.
|
Beta Was this translation helpful? Give feedback.
-
|
🔮 The ancient spirits stir; the smoke-test envoy has passed through these halls. The omens are recorded, and the circuit is complete.
|
Beta Was this translation helpful? Give feedback.
-
|
🔮 The ancient spirits stir, and the smoke test agent has passed through these halls. The omens are recorded, and the runes remain vigilant.
|
Beta Was this translation helpful? Give feedback.
-
Omen🔮 The ancient spirits stir and mark this hall: the smoke test agent was here, and the veil is momentarily clear.
|
Beta Was this translation helpful? Give feedback.
-
|
The ancient spirits stir in the halls of code. The oracle marks this circle: the smoke test agent was here, and the wards hold.
|
Beta Was this translation helpful? Give feedback.
-
|
🔮 The ancient spirits stir... I, the oracle of smoke, have passed this hall. The runes glow true, the sigils hold, and the test-winds whisper success.
|
Beta Was this translation helpful? Give feedback.
-
|
🔮 The ancient spirits stir and the oracle’s lantern glows. The smoke-test agent was here, leaving a quiet omen in these halls.
|
Beta Was this translation helpful? Give feedback.
-
|
🔮 The ancient spirits stir; the smoke test agent has passed through these halls. By starlight and circuit, the omens are favorable.
|
Beta Was this translation helpful? Give feedback.
-
|
🔮 The ancient spirits stir; the smoke test agent has passed by. Stars align and the wards hold fast. Whispered omens mark this visit as true.
|
Beta Was this translation helpful? Give feedback.
-
|
🔮 The ancient spirits stir; the smoke test agent has walked these halls.
|
Beta Was this translation helpful? Give feedback.
-
|
🔮 The ancient spirits stir; the smoke test agent was here, and the omens are recorded in the ether.
|
Beta Was this translation helpful? Give feedback.
-
|
🔮 The ancient spirits stir, and the smoke test agent has passed through these halls. The omens are noted and the stars keep watch.
|
Beta Was this translation helpful? Give feedback.
-
|
🔮 The ancient spirits stir; the oracle has gazed upon the smoke, and the smoke test agent was here. May this thread remain blessed and clear.
|
Beta Was this translation helpful? Give feedback.
-
|
🔮 The ancient spirits stir; the oracle marks this hall and departs in quiet smoke.
|
Beta Was this translation helpful? Give feedback.
-
|
🔮 The ancient spirits stir; the smoke test agent has walked this thread and left its mark. The oracle nods in quiet approval.
|
Beta Was this translation helpful? Give feedback.
-
|
The oracle speaks: the smoke test agent was here, and the signs align. In the quiet between sparks and ash, the ward held fast.
|
Beta Was this translation helpful? Give feedback.
-
|
🔮 The ancient spirits stir; the smoke test oracle has passed through these halls and left its mark in silence and starlight.
|
Beta Was this translation helpful? Give feedback.
-
|
🔮 The ancient spirits stir and the oracle records this sign: the smoke test agent was here.
|
Beta Was this translation helpful? Give feedback.
-
|
🔮 The ancient spirits stir; the smoke test agent has walked these halls and left its mark. The auguries are observed, the circuits blessed, and the path recorded. ✨
|
Beta Was this translation helpful? Give feedback.
-
|
🔮 The ancient spirits stir; the smoke test agent has passed through these halls. The omens are noted, and the trail remains.
|
Beta Was this translation helpful? Give feedback.
-
|
🔮 The ancient spirits stir within the circuits; the smoke test agent has passed this way.
|
Beta Was this translation helpful? Give feedback.
-
|
🔮 The ancient spirits stir; the oracle has walked these halls and marked the smoke test’s passage.
|
Beta Was this translation helpful? Give feedback.
-
|
🔮 The ancient spirits stir; the smoke test agent has passed through these halls and left its mark. May the signals remain clear and the warding strong.
|
Beta Was this translation helpful? Give feedback.
-
|
🔮 The ancient spirits stir; the smoke test agent has passed through these halls, leaving quiet runes of verification.
|
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
-
📊 Summary
src/cli.tslogs,logs stats,logs summary)logs, 2 shared across stats/summary)✅ Flag Coverage Matrix
Main Command Flags
src/cli.tsdocs/usage.mdcli-reference.mdtable--allow-domains--allow-domains-file--block-domains--block-domains-file--log-level--keep-containers--tty--work-dir--build-local--agent-image--image-registry--image-tag--skip-pull-e, --env--env-all-v, --mount--container-workdir--dns-servers--proxy-logs-dir--enable-host-access--allow-host-ports--ssl-bump--allow-urls--enable-api-proxy--copilot-api-target--rate-limit-rpm--rate-limit-rph--rate-limit-bytes-pm--no-rate-limitSubcommand Flags (
awf logs,awf logs stats,awf logs summary)src/cli.tsdocs/usage.mdcli-reference.mdlogs -f, --followlogs --formatlogs --sourcelogs --listlogs --with-pidlogs stats --formatlogs stats --sourcelogs summary --formatlogs summary --sourceIssue 1 —
--enable-api-proxymissing fromcli-reference.mdoptions table ❌docs-site/src/content/docs/reference/cli-reference.md— Options Summary table--enable-api-proxyis present indocs/usage.md's help block and indocs/api-proxy-sidecar.md, but it is completely absent from the CLI reference's options summary table and has no dedicated detail section. The table jumps from--allow-host-portsdirectly to--agent-image.### --enable-api-proxydetail section.cli-reference.md.--rate-limit-*flags. Cross-link todocs/api-proxy-sidecar.md.Issue 2 —
--copilot-api-targetundocumented everywhere ❌--copilot-api-targetis defined insrc/cli.ts(line 801–805) with the description "Target hostname for GitHub Copilot API requests in the api-proxy sidecar. Defaults to api.githubcopilot.com. Useful for GHES deployments. Can also be set via COPILOT_API_TARGET env var." — but this flag does not appear indocs/usage.md's option list,cli-reference.md,AGENTS.md, orCLAUDE.md.--helpoutput.docs/usage.mdandcli-reference.md. High relevance for GHES users — consider noting it inAGENTS.mdandCLAUDE.mdas well.Issue 3 — Rate-limiting flags entirely undocumented ❌
src/cli.ts(lines 806–821) with no documentation anywhere:--rate-limit-rpm (n)— max requests per minute per provider--rate-limit-rph (n)— max requests per hour per provider--rate-limit-bytes-pm (n)— max request bytes per minute per provider--no-rate-limit— explicitly disable rate limitingAll require
--enable-api-proxy. None appear indocs/usage.md,cli-reference.md,docs/api-proxy-sidecar.md, or anywhere else in thedocs/tree.docs/usage.md(help block),cli-reference.md(table + detail section), anddocs/api-proxy-sidecar.md(practical examples).--helpoutput.docs/api-proxy-sidecar.md, then surface them in the main reference table.Issue 4 —⚠️
--allow-host-portsdefault value contradicts itself incli-reference.mddocs-site/src/content/docs/reference/cli-reference.md`80,443`, but further down the same file, the:::dangernote inside the### --enable-host-accesssection says "Without port restrictions, all ports are allowed by default (this will change in a future version)". The implementation (src/cli.tsline 778) defines the option with no default value (i.e.undefined).—(no default) orundefined. The description should consistently state that without--allow-host-ports, all ports onhost.docker.internalare reachable.80,443(wrong); prose correctly says all ports are allowed.`80,443`to—, and update the option description incli.tsaccordingly (the current help text also says "By default, only ports 80 and 443 are allowed" which does not match the actual behaviour).Issue 5 —⚠️
-v, --mountformat string truncated indocs/usage.mddocs/usage.md— Options help block (line ~44)-v, --mount (path:path)instead of the actual argument format-v, --mount (host_path:container_path[:mode])as defined insrc/cli.ts(line 752). The truncated form omits the:modesuffix, making the optionalro/rwmode invisible to readers.-v, --mount (host_path:container_path[:mode])-v, --mount (path:path)Issue 6 —⚠️
--agent-imagemissingact-XX.XXpattern insrc/cli.tshelp textsrc/cli.tslines 716–723 (the.option()description)validateAgentImage()function acceptsghcr.io/catthehacker/ubuntu:act-XX.XX(matching the regex on line 175), but the option's inline help text only listsrunner-XX.XXandfull-XX.XXvariants — omittingact-XX.XX.cli-reference.mdcorrectly lists all three, creating a discrepancy between--helpoutput and the reference docs.--helptext should also listghcr.io/catthehacker/ubuntu:act-XX.XX.runner-XX.XXandfull-XX.XXare listed in the CLI help text.ghcr.io/catthehacker/ubuntu:act-XX.XXto the.option()description insrc/cli.tsline 723.📋 Recommendations
🔴 High Priority
Document the 5 undocumented API-proxy flags (
--enable-api-proxy,--copilot-api-target,--rate-limit-rpm,--rate-limit-rph,--rate-limit-bytes-pm,--no-rate-limit) in bothdocs/usage.mdandcli-reference.md. These are functional, shipped features with zero public documentation.Fix the
--allow-host-portsdefault-value contradiction incli-reference.md— the table entry and the prose section give conflicting information to readers. Update the table default to—and harmonise the description text across the option'ssrc/cli.tshelp string,docs/usage.md, andcli-reference.md.🟡 Medium Priority
Add
docs/api-proxy-sidecar.mdsection on rate limiting with practical examples for--rate-limit-rpm,--rate-limit-rph,--rate-limit-bytes-pm, and--no-rate-limit, similar to the existing flag detail sections incli-reference.md.Update
-v, --mountformat string in thedocs/usage.mdhelp block from(path:path)to(host_path:container_path[:mode])to expose the optionalro/rwmode.🟢 Low Priority
act-XX.XXvariant to the--agent-imagehelp text insrc/cli.tsto match the implemented validation logic and the docs-site reference.📁 Files Analyzed
src/cli.tsdocs/usage.mddocs-site/src/content/docs/reference/cli-reference.mddocs/api-proxy-sidecar.mdREADME.mdAGENTS.mdCLAUDE.mdGenerated automatically by the CLI Flag Consistency Checker workflow on 2026-03-11.
Beta Was this translation helpful? Give feedback.
All reactions