-
Notifications
You must be signed in to change notification settings - Fork 46
Closed as not planned
Closed as not planned
Copy link
Labels
automationclidocumentationImprovements or additions to documentationImprovements or additions to documentation
Description
Problem
The gh aw campaign validate subcommand is implemented in the CLI but not properly documented in docs/src/content/docs/setup/cli.md. While line 288 mentions it briefly in the example list, there is no detailed section explaining what it does, how to use it, or what flags are available.
Evidence
Implementation: pkg/campaign/command.go lines 147-178
validateCmd := &cobra.Command{
Use: "validate [filter]",
Short: "Validate campaign spec files for common issues",
Long: `Validate campaign spec files under .github/workflows/*.campaign.md.
This command performs lightweight semantic validation of campaign
definitions (IDs, tracker labels, workflows, lifecycle state, and
other key fields). By default it exits with a non-zero status when
problems are found.
...
}Documentation: docs/src/content/docs/setup/cli.md line 288 shows:
gh aw campaign validate # Validate specs (fails on problems)But there's no detailed section in the "Agentic campaigns" part of the documentation.
Expected Fix
Add a complete documentation section for campaign validate in the Agentic campaigns section that includes:
- Full description of what validation checks are performed
- Usage examples showing different scenarios
- Flag documentation:
--json- Output validation results in JSON format--strict/--no-strict- Control exit status behavior
- When to use it - Best practices and use cases
Files to Update
docs/src/content/docs/setup/cli.md- Add detailed section forcampaign validate
Priority
Medium - This is a functional subcommand that users need to discover and understand how to use effectively.
AI generated by CLI Consistency Checker
Copilot
Metadata
Metadata
Labels
automationclidocumentationImprovements or additions to documentationImprovements or additions to documentation