Skip to content

Sync CLI docs and refresh compiled workflow artifacts for consistency checker#2115

Merged
lpcox merged 7 commits intomainfrom
copilot/fix-cli-flag-consistency
Apr 20, 2026
Merged

Sync CLI docs and refresh compiled workflow artifacts for consistency checker#2115
lpcox merged 7 commits intomainfrom
copilot/fix-cli-flag-consistency

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 20, 2026

The CLI Flag Consistency Checker surfaced drift between src/cli.ts and docs: missing/undocumented flags, stale defaults, and incomplete subcommand coverage. This PR aligns docs/usage.md and docs-site CLI reference with current CLI behavior.

  • CLI option parity (docs/usage.md)

    • Added missing runtime flags: --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.
    • Corrected --memory-limit default from 2g to 6g.
  • Subcommand coverage (docs/usage.md)

    • Added missing predownload command block.
    • Added missing logs audit command block and filters.
  • Reference doc completeness (docs-site/src/content/docs/reference/cli-reference.md)

    • Extended options summary with missing flags above.
    • Added missing option detail sections (--config, --docker-host, --upstream-proxy, --session-state-dir, Gemini API target/base path, DIFC proxy host/CA cert, --diagnostic-logs).
    • Added predownload --difc-proxy option and example.
    • Clarified that --difc-proxy is the predownload flag for runtime --difc-proxy-host.
  • Workflow refresh after maintainer feedback

    • Rebased the branch onto latest main.
    • Recompiled agentic workflows and committed regenerated .lock.yml artifacts.
    • Ran required post-processing (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

Copilot AI linked an issue Apr 20, 2026 that may be closed by this pull request
Copilot AI changed the title [WIP] Fix CLI flag consistency issues in documentation Sync CLI docs with implemented flags and subcommands for consistency checker Apr 20, 2026
Copilot AI requested a review from lpcox April 20, 2026 13:53
@lpcox lpcox marked this pull request as ready for review April 20, 2026 14:34
@lpcox lpcox requested a review from Mossaka as a code owner April 20, 2026 14:34
Copilot AI review requested due to automatic review settings April 20, 2026 14:34
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 20, 2026

Documentation Preview

Documentation build failed for this PR. View logs.

Built from commit cd26d66

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions github-actions bot mentioned this pull request Apr 20, 2026
Copy link
Copy Markdown
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

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-limit default to 6g.
  • Documented missing subcommands/blocks: predownload and logs audit (including filters).
  • Expanded the docs-site CLI reference with new option rows and detailed sections plus predownload --difc-proxy coverage.
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

Comment thread docs/usage.md Outdated
@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@lpcox
Copy link
Copy Markdown
Collaborator

lpcox commented Apr 20, 2026

@copilot rebase to main and recompile

Copy link
Copy Markdown
Contributor Author

Copilot AI commented Apr 20, 2026

@copilot rebase to main and recompile

Done — rebased this branch onto latest main and recompiled workflows (with post-processing), then pushed the updated artifacts in 76e8a96.

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:

  • https://api.github.com/repos/actions/github-script/git/ref/tags/v9
    • Triggering command: /usr/bin/gh gh api /repos/actions/github-script/git/ref/tags/v9 --jq .object.sha (http block)
    • Triggering command: /usr/bin/gh gh api /repos/actions/github-script/git/ref/tags/v9 --jq [.object.sha, .object.type] | @tsv -c=4 -nolocalimports -importcfg /tmp/go-build4108201482/b129/importcfg -pack /home/REDACTED/go/pkg/mod/charm.land/bubbles/v2@v2.1.0/cursor/cursor.go tmp/go-build conf�� 0.1-go1.25.9.lin. 0.1-go1.25.9.lin--gdwarf2 rg/toolchain@v0.--64 pull.rebase (http block)
  • https://api.github.com/repos/github/gh-aw-actions/git/ref/tags/v0.68.3
    • Triggering command: /usr/bin/gh gh api /repos/github/gh-aw-actions/git/ref/tags/v0.68.3 --jq .object.sha (http block)
  • https://api.github.com/repos/github/gh-aw/releases/latest
    • Triggering command: /usr/bin/gh gh extension install github/gh-aw (http block)

If you need me to access, download, or install something from one of these locations, you can either:

Copilot AI changed the title Sync CLI docs with implemented flags and subcommands for consistency checker Sync CLI docs and refresh compiled workflow artifacts for consistency checker Apr 20, 2026
@github-actions
Copy link
Copy Markdown
Contributor

✅ Coverage Check Passed

Overall Coverage

Metric Base PR Delta
Lines 85.74% 85.83% 📈 +0.09%
Statements 85.76% 85.84% 📈 +0.08%
Functions 88.04% 88.04% ➡️ +0.00%
Branches 79.91% 79.95% 📈 +0.04%
📁 Per-file Coverage Changes (1 files)
File Lines (Before → After) Statements (Before → After)
src/docker-manager.ts 86.8% → 87.1% (+0.30%) 86.4% → 86.7% (+0.29%)

Coverage comparison generated by scripts/ci/compare-coverage.ts

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

Copilot AI and others added 7 commits April 20, 2026 09:16
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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>
@lpcox lpcox force-pushed the copilot/fix-cli-flag-consistency branch from 38bcf40 to ee264d0 Compare April 20, 2026 16:16
@github-actions
Copy link
Copy Markdown
Contributor

🔥 Smoke Test Results

Test Result
GitHub MCP (list_pull_requests → PR #2114: "Handle non-standard runner HOME...")
GitHub.com connectivity
File write/read (smoke-test-copilot-24677468156.txt)

Overall: PASS

PR: "Sync CLI docs and refresh compiled workflow artifacts for consistency checker" — author @app/copilot-swe-agent, assignees @lpcox @Copilot

📰 BREAKING: Report filed by Smoke Copilot

@github-actions
Copy link
Copy Markdown
Contributor

Smoke Test Results:

Overall: PASS

💥 [THE END] — Illustrated by Smoke Claude

@github-actions
Copy link
Copy Markdown
Contributor

🔥 Smoke Test: Copilot BYOK (Offline) Mode

Test Result
GitHub MCP (list_pull_requests#2114)
GitHub.com connectivity (HTTP 200)
File write/read (smoke-test-copilot-byok-24677468175.txt)
BYOK inference (agent → api-proxy → api.githubcopilot.com)

Overall: PASS — Running in BYOK offline mode (COPILOT_OFFLINE=true) via api-proxy → api.githubcopilot.com

Author: @app/copilot-swe-agent · Assignees: @lpcox @Copilot

🔑 BYOK report filed by Smoke Copilot BYOK

@github-actions
Copy link
Copy Markdown
Contributor

Smoke Test Results: GitHub Actions Services Connectivity

Check Status Notes
Redis PING (host.docker.internal:6379) ❌ FAIL redis-cli not available; cannot install (no apt access)
PostgreSQL pg_isready (host.docker.internal:5432) ✅ PASS accepting connections
PostgreSQL SELECT 1 (db: smoketest, user: postgres) ✅ PASS Returned 1

2/3 checks passed. Redis check could not be executed due to missing redis-cli tool.

🔌 Service connectivity validated by Smoke Services

@github-actions
Copy link
Copy Markdown
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 passed ✅ PASS
Node.js execa passed ✅ PASS
Node.js p-limit 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 #2115 · ● 979.7K ·

@lpcox lpcox merged commit c1877ce into main Apr 20, 2026
49 of 53 checks passed
@lpcox lpcox deleted the copilot/fix-cli-flag-consistency branch April 20, 2026 16:38
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.

[aw] CLI Flag Consistency Checker failed

3 participants