Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 14 additions & 4 deletions docs/src/content/docs/setup/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,19 @@ gh aw logs my-workflow # Download and analyze execution logs
```bash wrap
gh aw status # Check workflow state and configuration
gh aw logs my-workflow # Review execution logs (AI decisions, tool usage, errors)
gh aw audit (run-id) # Analyze specific run in detail
gh aw audit (run-id-or-url) # Analyze specific run in detail

# Fix issues
gh aw secrets bootstrap --engine copilot # Check token configuration
gh aw compile my-workflow --validate # Detailed validation
gh aw fix my-workflow --write # Auto-fix deprecated fields
```

Run-id is in the URL: `github.com/owner/repo/actions/runs/12345678` → `12345678`
The audit command accepts run IDs, workflow URLs, job URLs, or step URLs:
- Run ID from URL: `github.com/owner/repo/actions/runs/12345678` → `12345678`
- Or use the full URL: `https://github.com/owner/repo/actions/runs/12345678`
- Job URL: `https://github.com/owner/repo/actions/runs/123/job/456` (extracts first failing step)
- Step URL: `https://github.com/owner/repo/actions/runs/123/job/456#step:7:1` (extracts specific step)

## Installation

Expand Down Expand Up @@ -266,14 +270,20 @@ gh aw logs --campaign # Campaign orchestrators only

#### `audit`

Analyze specific runs with overview, metrics, tool usage, MCP failures, firewall analysis, noops, and artifacts. Accepts run IDs or URLs. Auto-detects Copilot agent runs for specialized parsing.
Analyze specific runs with overview, metrics, tool usage, MCP failures, firewall analysis, noops, and artifacts. Accepts run IDs, workflow run URLs, job URLs, and step-level URLs. Auto-detects Copilot agent runs for specialized parsing.

When provided with a job URL, automatically extracts logs for the specific job. When a step fragment is included, extracts only that step's output. If no step is specified, automatically identifies and extracts the first failing step.

```bash wrap
gh aw audit 12345678 # By run ID
gh aw audit https://github.com/owner/repo/actions/runs/123 # By URL
gh aw audit https://github.com/owner/repo/actions/runs/123 # By workflow run URL
gh aw audit https://github.com/owner/repo/actions/runs/123/job/456 # By job URL (extracts first failing step)
gh aw audit https://github.com/owner/repo/actions/runs/123/job/456#step:7:1 # By step URL (extracts specific step)
gh aw audit 12345678 --parse # Parse logs to markdown
```

Logs are saved to `logs/run-{id}/` with filenames indicating the extraction level (job logs, specific step, or first failing step).

### Agentic campaigns

#### `campaign`
Expand Down
2 changes: 1 addition & 1 deletion docs/src/content/docs/setup/mcp-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ The MCP server provides:
- **status**: List workflows with pattern filter
- **compile**: Generate GitHub Actions YAML
- **logs**: Download with timeout handling and continuation
- **audit**: Generate report to `/tmp/gh-aw/aw-mcp/logs`
- **audit**: Generate report to `/tmp/gh-aw/aw-mcp/logs`. Accepts run IDs, workflow run URLs, job URLs, and step-level URLs for precise failure analysis
- **update**: Update workflows with support for major version updates and force flag
- **add**: Install workflows from remote repositories
- **mcp-inspect**: Inspect servers and validate secrets
Expand Down