Skip to content

[docs] Self-healing documentation fixes from issue analysis - 2026-03-27 #23240

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.

Sign up for GitHub

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

Merged
pelikhan merged 1 commit into from
Mar 27, 2026
Merged

[docs] Self-healing documentation fixes from issue analysis - 2026-03-27 #23240

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 36 additions & 1 deletion docs/src/content/docs/setup/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -384,7 +384,11 @@ gh aw logs "ci failure doctor" # Case-insensitive display name

#### `audit`

Analyze specific runs with a rich multi-section report. Accepts run IDs, workflow run URLs, job URLs, and step-level URLs. Auto-detects Copilot coding agent runs for specialized parsing. Job URLs automatically extract specific job logs; step URLs extract specific steps; without step, extracts first failing step.
Analyze workflow runs with detailed reports. The `audit` command has three modes: a single-run audit (default), a cross-run diff, and a cross-run security report.

##### `audit <run-id>`
Copy link

Copilot AI Mar 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The subsection header audit <run-id> is inconsistent with the actual CLI usage and the paragraph immediately below it (which says URLs are accepted). The audit command’s Use string is audit <run-id-or-url>, so the docs header should reflect that to avoid implying only numeric IDs are supported.

This issue also appears in the following locations of the same file:

  • line 390
  • line 435
  • line 437
  • line 453
Suggested change
##### `audit <run-id>`
##### `audit <run-id-or-url>`

Copilot uses AI. Check for mistakes.

Analyze a single run with a rich multi-section report. Accepts run IDs, workflow run URLs, job URLs, and step-level URLs. Auto-detects Copilot coding agent runs for specialized parsing. Job URLs automatically extract specific job logs; step URLs extract specific steps; without step, extracts first failing step.

```bash wrap
gh aw audit 12345678 # By run ID
Expand Down Expand Up @@ -417,6 +421,37 @@ Logs are saved to `logs/run-{id}/` with filenames indicating the extraction leve
| **Jobs** | Status of each GitHub Actions job in the run |
| **Artifacts** | Downloaded artifacts and their contents |

##### `audit diff`

Compare behavior between two workflow runs to detect policy regressions, new unauthorized domains, behavioral drift, and changes in MCP tool usage or run metrics.

```bash wrap
gh aw audit diff 12345 12346 # Compare two runs
gh aw audit diff 12345 12346 --format markdown # Markdown output for PR comments
gh aw audit diff 12345 12346 --json # JSON for CI integration
gh aw audit diff 12345 12346 --repo owner/repo # Specify repository
```

The diff output shows: new or removed network domains, status changes (allowed ↔ denied), volume changes (>100% threshold), MCP tool invocation changes, and run metric comparisons (token usage, duration, turns).

**Options:** `--format` (pretty, markdown, json; default: pretty), `--json`, `--repo/-r`

##### `audit report`

Generate a comprehensive cross-run security audit report by aggregating firewall data across multiple recent runs. Designed for security reviews, compliance checks, and feeding debugging or optimization agents.

```bash wrap
gh aw audit report # Report on recent runs (default: last 20)
gh aw audit report --workflow "agent-task" --last 10 # Report on last 10 runs of a workflow
gh aw audit report --workflow "agent-task" --last 5 --json # JSON for dashboards
gh aw audit report --format pretty # Console-formatted output
gh aw audit report --repo owner/repo --last 10 # Report on a specific repository
```

Output is Markdown by default (suitable for security reviews, piping to files, or `$GITHUB_STEP_SUMMARY`).

**Options:** `--workflow/-w` (filter by workflow name or filename), `--last` (number of recent runs to analyze; default: 20, max: 50), `--format` (markdown, pretty, json; default: markdown), `--json`, `--repo/-r`

#### `health`

Display workflow health metrics and success rates.
Expand Down
Loading