Sync CLI docs and refresh compiled workflow artifacts for consistency checker#2115
Sync CLI docs and refresh compiled workflow artifacts for consistency checker#2115
Conversation
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
Pull request overview
Aligns CLI documentation with the actual flags, defaults, and subcommands implemented in the awf CLI, reducing drift detected by the consistency checker.
Changes:
- Added/updated documentation for missing runtime flags (e.g.,
--config,--docker-host,--upstream-proxy, Gemini/DIFC flags,--diagnostic-logs) and corrected the--memory-limitdefault to6g. - Documented missing subcommands/blocks:
predownloadandlogs audit(including filters). - Expanded the docs-site CLI reference with new option rows and detailed sections plus
predownload --difc-proxycoverage.
Show a summary per file
| File | Description |
|---|---|
| docs/usage.md | Updates the “help-style” usage block to include missing flags/defaults and adds predownload + logs audit sections. |
| docs-site/src/content/docs/reference/cli-reference.md | Extends the options summary and adds detailed reference sections/examples for newly documented flags and predownload --difc-proxy. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 2/2 changed files
- Comments generated: 1
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
@copilot rebase to main and recompile |
Done — rebased this branch onto latest Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
✅ Coverage Check PassedOverall Coverage
📁 Per-file Coverage Changes (1 files)
Coverage comparison generated by |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: lpcox <15877973+lpcox@users.noreply.github.com>
Agent-Logs-Url: https://github.com/github/gh-aw-firewall/sessions/4f16749e-8ad3-433a-a9a6-e3eff88697da Co-authored-by: lpcox <15877973+lpcox@users.noreply.github.com>
The Copilot agent incorrectly replaced all github/gh-aw-actions/setup@SHA references with ./actions/setup (a local path that doesn't exist) across all lock files. This reverts those changes, keeping only the documentation updates to docs/usage.md and docs-site CLI reference. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
38bcf40 to
ee264d0
Compare
🔥 Smoke Test Results
Overall: PASS PR: "Sync CLI docs and refresh compiled workflow artifacts for consistency checker" — author
|
|
Smoke Test Results:
Overall: PASS
|
🔥 Smoke Test: Copilot BYOK (Offline) Mode
Overall: PASS — Running in BYOK offline mode ( Author:
|
Smoke Test Results: GitHub Actions Services Connectivity
2/3 checks passed. Redis check could not be executed due to missing
|
🏗️ Build Test Suite Results
Overall: 8/8 ecosystems passed — ✅ PASS
|
The CLI Flag Consistency Checker surfaced drift between
src/cli.tsand docs: missing/undocumented flags, stale defaults, and incomplete subcommand coverage. This PR alignsdocs/usage.mdanddocs-siteCLI reference with current CLI behavior.CLI option parity (
docs/usage.md)--config,--docker-host,--upstream-proxy,--diagnostic-logs,--gemini-api-target,--gemini-api-base-path,--difc-proxy-host,--difc-proxy-ca-cert,--exclude-env,--env-file,--allow-host-service-ports,--audit-dir,--openai-api-base-path,--anthropic-api-base-path.--memory-limitdefault from2gto6g.Subcommand coverage (
docs/usage.md)predownloadcommand block.logs auditcommand block and filters.Reference doc completeness (
docs-site/src/content/docs/reference/cli-reference.md)--config,--docker-host,--upstream-proxy,--session-state-dir, Gemini API target/base path, DIFC proxy host/CA cert,--diagnostic-logs).predownload --difc-proxyoption and example.--difc-proxyis the predownload flag for runtime--difc-proxy-host.Workflow refresh after maintainer feedback
main..lock.ymlartifacts.scripts/ci/postprocess-smoke-workflows.ts) on regenerated lock files.# Newly documented + aligned examples sudo awf --config ./awf.yml -- curl https://api.github.com sudo awf --upstream-proxy http://proxy.corp.com:3128 --allow-domains github.com -- curl https://api.github.com awf predownload --difc-proxy awf logs audit --decision denied