[cli-consistency] Missing detailed campaign command documentation #11291
Description
Issue Description
Command: gh aw campaign
Type: Documentation completeness
Priority: Low
Location: docs/src/content/docs/setup/cli.md
Current State
The campaign command is briefly mentioned in the documentation under "Agentic campaigns" section, but lacks:
- Full command syntax documentation
- Subcommand details (status, new, validate are mentioned but not fully documented)
- Flag reference
- Comprehensive examples
Command Details (from source)
Main command:
Use: "campaign [filter]"
Short: "Inspect first-class campaign definitions from .github/workflows/*.campaign.md"
Subcommands (from pkg/campaign/command.go):
(list)- Default action, lists campaignsstatus- Show live status for campaignsnew- Create a new campaign specvalidate- Validate campaign specs (fails on problems)
Current Documentation
From docs/src/content/docs/setup/cli.md (lines 336-348):
#### `campaign`
Manage campaign definitions in `.github/workflows/*.campaign.md`. Supports cursor-based discovery, governance controls for safe scaling.
```bash wrap
gh aw campaign # List all campaigns
gh aw campaign security # Filter by ID/name
gh aw campaign status # Live status
gh aw campaign new my-campaign-id # Scaffold new spec
gh aw campaign validate # Validate specs (fails on problems)See Agentic campaigns guide for full spec and defaults.
### Issues
1. **Missing subcommand details** - Each subcommand should have its own subsection like `mcp` does
2. **No flag documentation** - Flags like `--filter`, `--json`, etc. are not documented
3. **Limited examples** - Only basic usage shown
4. **Inconsistent depth** - Other commands have more comprehensive documentation
### Suggested Fix
**Option 1**: Expand in-place with subcommands:
``````markdown
#### `campaign`
Manage first-class campaign definitions from `.github/workflows/*.campaign.md`.
```bash wrap
gh aw campaign # List all campaigns
gh aw campaign security # Filter by ID/name
gh aw campaign --json # JSON output
Subcommands:
campaign status
Show live status for campaigns including compiled workflows and repo-memory metrics.
gh aw campaign status # All campaigns
gh aw campaign status security # Specific campaigncampaign new
Create a new campaign spec under .github/workflows/.
gh aw campaign new my-campaign-id # Create new campaigncampaign validate
Validate campaign specs (fails on validation errors).
gh aw campaign validate # Validate all campaignsSee Agentic campaigns guide for complete documentation.
**Option 2**: Keep brief but add clear cross-reference:
``````markdown
#### `campaign`
Manage campaign definitions. See [Agentic Campaigns Guide](/gh-aw/guides/campaigns/) for complete documentation.
**Quick Reference:**
- `gh aw campaign` - List campaigns
- `gh aw campaign status` - Show live status
- `gh aw campaign new (id)` - Create new campaign
- `gh aw campaign validate` - Validate specs
Recommendation
Option 2 (brief with cross-reference) is recommended since campaigns have a dedicated guide. This keeps the CLI reference focused while directing users to comprehensive documentation.
Related to #11286
AI generated by CLI Consistency Checker