docs: add missing health command to CLI reference#14273
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Adds missing CLI reference documentation for the existing gh aw health analysis command, improving discoverability for workflow health analytics.
Changes:
- Documented the
healthcommand under the Monitoring section, alongside other analysis/monitoring tools. - Included usage examples, options list, and a summary of reported metrics.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| gh aw health issue-monster --days 90 # 90-day metrics for workflow | ||
| ``` | ||
|
|
||
| **Options:** `--days`, `--threshold`, `--repo`, `--json` |
There was a problem hiding this comment.
--days is restricted by the implementation to only 7, 30, or 90 (and defaults to 7). The docs currently show examples but don’t state the allowed values, which can lead to users trying unsupported values and hitting an error. Consider explicitly documenting the allowed set (and default) near the Options line.
| **Options:** `--days`, `--threshold`, `--repo`, `--json` | |
| **Options:** `--days` (allowed values: 7, 30, or 90; default: 7), `--threshold`, `--repo`, `--json` |
| - Success/failure rates over time period | ||
| - Trend indicators (↑ improving, → stable, ↓ degrading) | ||
| - Average execution duration and token usage | ||
| - Average and total cost |
There was a problem hiding this comment.
The metrics list says “Average and total cost”, but gh aw health (summary view) only renders average cost in the table; total cost is only shown in the per-workflow detailed view (and in JSON fields). Suggest rewording this bullet to avoid implying total cost is always displayed in the summary output.
| - Average and total cost | |
| - Average cost (with total cost available in detailed and JSON views) |
The
healthcommand was fully implemented and registered as an analysis command but absent from CLI documentation, making it undiscoverable to users.Changes
healthcommand documentation in the Monitoring section ofdocs/src/content/docs/setup/cli.mdauditcommand for logical grouping of analysis tools--days,--threshold,--repo,--json) and metrics (success rates, trends, token usage, costs)The command provides workflow health analytics including success rates over configurable time periods (7/30/90 days), trend indicators, and cost tracking - critical for maintaining workflow quality.
Original prompt
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.