-
Notifications
You must be signed in to change notification settings - Fork 144
[docs] Unbloat CLI commands reference documentation #15211
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Reduced cli.md from 689 to 577 lines (16% reduction) by: - Consolidated three repetitive --push flag explanations into single shared section - Removed verbose installation descriptions - Condensed command descriptions and removed filler words - Simplified option lists and feature descriptions - Tightened error reporting and dependency integration explanations All essential information preserved while improving readability. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Reduces and consolidates the CLI reference documentation to remove repetition (notably --push) while keeping essential usage and links intact.
Changes:
- Consolidated repeated
--pushdocumentation into a single “Global Options” section and linked to it from commands - Condensed verbose command descriptions, examples, and option explanations across multiple sections
- Simplified several option/feature lists into shorter summaries with links to deeper references
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| Several commands support the `--push` flag to automatically commit and push changes to the remote repository: | ||
|
|
||
| 1. **Remote check**: Requires a remote repository to be configured | ||
| 2. **Branch validation**: Verifies current branch matches repository default branch (or specified with `--ref`) |
Copilot
AI
Feb 12, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The global --push description references --ref, but not all --push-supporting commands accept --ref (e.g., init, upgrade in this doc). To avoid implying --ref is universally available, reword step 2 to be command-specific (e.g., “matches the default branch (or a command-provided target ref, if supported)”) or move the --ref mention into the run command section only.
| 2. **Branch validation**: Verifies current branch matches repository default branch (or specified with `--ref`) | |
| 2. **Branch validation**: Verifies current branch matches the repository's default branch (or a command-provided target branch/ref, if supported) |
| gh aw upgrade # Upgrade repository agent files and all workflows | ||
| gh aw upgrade --no-fix # Update agent files only (skip codemods and compilation) | ||
| gh aw upgrade --push # Upgrade and automatically commit/push changes | ||
| gh aw upgrade --no-fix # Update agent files only (skip codemods) |
Copilot
AI
Feb 12, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This change removes “and compilation” from the --no-fix description. Earlier text indicated --no-fix skips both codemods and compilation; if that behavior is still true, this line is now inaccurate and should be restored/clarified (e.g., “skip codemods and compilation”). If behavior changed, consider a brief note explaining what still happens (e.g., whether workflows are recompiled or not) to prevent confusion.
| - Version information (gh-aw, awf, agents) | ||
|
|
||
| The hash can be used to detect configuration changes between compilation and execution. | ||
| Includes all frontmatter fields, imported workflow frontmatter (BFS traversal), template expressions containing `env.` or `vars.`, and version information (gh-aw, awf, agents). |
Copilot
AI
Feb 12, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This sentence no longer has a clear subject (it’s unclear what “Includes …” refers to when scanning). Consider changing it to “The hash includes …” to preserve clarity after removing the preceding “The hash includes:” lead-in.
| Includes all frontmatter fields, imported workflow frontmatter (BFS traversal), template expressions containing `env.` or `vars.`, and version information (gh-aw, awf, agents). | |
| The hash includes all frontmatter fields, imported workflow frontmatter (BFS traversal), template expressions containing `env.` or `vars.`, and version information (gh-aw, awf, agents). |
Summary
Reduced
docs/src/content/docs/setup/cli.mdfrom 689 lines to 577 lines (112 lines removed, 16% reduction) by removing documentation bloat while preserving all essential information.Changes Made
Consolidated Repetitive Content
--pushflag documentation: The--pushflag was explained in detail in THREE separate places (init, run, upgrade) with nearly identical wording. Created a single shared section under "Global Options" and linked to it from each command.Removed Verbose Descriptions
gh awcommands" and simplified firewall descriptionTightened Technical Content
Simplified Option Lists
Improvements
--pushflag is now documented once with clear links from each usageIssues
Screenshots could not be captured: Playwright was unable to connect to localhost during screenshot capture. This appears to be a network sandbox restriction in the GitHub Actions environment. The documentation preview server was running correctly (verified via curl), but Playwright browser connections to
(localhost/redacted) resulted inERR_CONNECTION_REFUSED`.Recommendation: Manual screenshot capture or workflow environment configuration to allow Playwright browser connections to localhost would resolve this for future runs.
Testing
Metrics
--pushexplanations (×3), verbose installation descriptions, redundant command descriptions, filler words