From 17bad0146f38ced604c3d4e7e3f1f5f58542ac50 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 12 Jun 2026 11:59:14 +0000 Subject: [PATCH] [docs] Document --gh-aw-ref flag and fix mcp add inline comment Documents two CLI gaps surfaced by daily activity: - Adds `--gh-aw-ref` to the `compile` options list and a short description explaining branch/tag SHA resolution (PR #38689). - Corrects the `gh aw mcp add` inline comment to reflect that the no-argument form lists registry servers, and adds a separate line showing the add form (#38386 item 3). Co-Authored-By: Claude Sonnet 4 --- docs/src/content/docs/setup/cli.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/src/content/docs/setup/cli.md b/docs/src/content/docs/setup/cli.md index 7c66175fc37..7fb5d15d010 100644 --- a/docs/src/content/docs/setup/cli.md +++ b/docs/src/content/docs/setup/cli.md @@ -293,7 +293,9 @@ gh aw compile --purge # Remove orphaned .lock.yml files If the repository root contains an [`aw.yml` manifest](/gh-aw/reference/aw-yml-package-manifest/), `gh aw compile` validates it before compiling workflows. -**Options:** `--action-mode`, `--action-tag`, `--actionlint`, `--actions-repo`, `--allow-action-refs`, `--approve`, `--dependabot`, `--dir/-d`, `--engine/-e`, `--fail-fast`, `--fix`, `--force`, `--force-refresh-action-pins`, `--ghes`, `--json/-j`, `--logical-repo`, `--no-check-update`, `--no-emit`, `--poutine`, `--purge`, `--refresh-stop-time`, `--runner-guard`, `--schedule-seed`, `--show-all`, `--staged`, `--stats`, `--strict`, `--trial`, `--validate`, `--validate-images`, `--watch/-w`, `--zizmor` +**Options:** `--action-mode`, `--action-tag`, `--actionlint`, `--actions-repo`, `--allow-action-refs`, `--approve`, `--dependabot`, `--dir/-d`, `--engine/-e`, `--fail-fast`, `--fix`, `--force`, `--force-refresh-action-pins`, `--gh-aw-ref`, `--ghes`, `--json/-j`, `--logical-repo`, `--no-check-update`, `--no-emit`, `--poutine`, `--purge`, `--refresh-stop-time`, `--runner-guard`, `--schedule-seed`, `--show-all`, `--staged`, `--stats`, `--strict`, `--trial`, `--validate`, `--validate-images`, `--watch/-w`, `--zizmor` + +**`--gh-aw-ref` flag:** Convenience alias for `--action-mode release --action-tag `. Accepts a branch name, tag, or commit SHA targeting the `github/gh-aw` repository. Branch and tag names are resolved to their full commit SHA at compile time, so the baked-in reference is immutable and reproducible. Useful for E2E-testing workflows compiled against a specific gh-aw revision. **`--approve` flag:** When compiling a workflow that already has a lock file, the compiler enforces *safe update mode* — any newly added secrets or custom actions not present in the previous manifest require explicit approval. Pass `--approve` to accept these changes and regenerate the manifest baseline. On first compile (no existing lock file), enforcement is skipped automatically and `--approve` is not needed. @@ -725,7 +727,8 @@ gh aw mcp list workflow # List servers for workflow gh aw mcp list-tools --server github # List tools for a server (all workflows) gh aw mcp list-tools workflow --server github # List tools for a server in a specific workflow gh aw mcp inspect workflow # Inspect and test servers -gh aw mcp add # Add MCP tool to workflow +gh aw mcp add # List available MCP servers from the registry +gh aw mcp add # Add an MCP server to a workflow ``` See [MCPs Guide](/gh-aw/guides/mcps/).