Skip to content

Fix CLI help text consistency: codemods list, --repeat semantics, disable behavior, project new formatting #19230

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 2 commits into from
Mar 2, 2026
Merged

Fix CLI help text consistency: codemods list, --repeat semantics, disable behavior, project new formatting #19230

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d9c069b
Initial plan
Copilot Mar 2, 2026
3666f67
Fix CLI consistency issues: fix codemods list, --repeat flag, disable…
Copilot Mar 2, 2026
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
6 changes: 3 additions & 3 deletions cmd/gh-aw/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ var disableCmd = &cobra.Command{
Use: "disable [workflow]...",
Short: "Disable agentic workflows and cancel any in-progress runs",
Long: `Disable one or more workflows by ID, or all workflows if no IDs are provided.

Any in-progress runs will be cancelled before disabling.
Copy link

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

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

The "Any in-progress runs will be cancelled before disabling." line is immediately followed by the WorkflowIDExplanation block with no blank line separator. Comparing with the enableCmd Long description (which has a blank line before WorkflowIDExplanation), and other commands like fix, health, logs, and validate (all of which wrap WorkflowIDExplanation with blank lines on both sides), the disableCmd description is missing a blank line between the cancellation note and the workflow ID explanation. This inconsistency will cause the two sections to visually run together in the help output.

Suggested change
Any in-progress runs will be cancelled before disabling.
Any in-progress runs will be cancelled before disabling.

Copilot uses AI. Check for mistakes.
` + cli.WorkflowIDExplanation + `

Examples:
Expand Down Expand Up @@ -355,7 +355,7 @@ Examples:
gh aw run daily-perf-improver
gh aw run daily-perf-improver.md # Alternative format
gh aw run daily-perf-improver --ref main # Run on specific branch
gh aw run daily-perf-improver --repeat 3 # Run 3 times total
gh aw run daily-perf-improver --repeat 3 # Run 4 times total (1 initial + 3 repeats)
gh aw run daily-perf-improver --enable-if-needed # Enable if disabled, run, then restore state
gh aw run daily-perf-improver --auto-merge-prs # Auto-merge any PRs created during execution
gh aw run daily-perf-improver -F name=value -F env=prod # Pass workflow inputs
Expand Down Expand Up @@ -656,7 +656,7 @@ Use "` + string(constants.CLIExtensionPrefix) + ` help all" to show help for all
disableCmd.ValidArgsFunction = cli.CompleteWorkflowNames

// Add flags to run command
runCmd.Flags().Int("repeat", 0, "Number of times to repeat running workflows (0 = run once)")
runCmd.Flags().Int("repeat", 0, "Number of additional times to run after the initial execution (e.g., --repeat 3 runs 4 times total)")
runCmd.Flags().Bool("enable-if-needed", false, "Enable the workflow before running if needed, and restore state afterward")
runCmd.Flags().StringP("engine", "e", "", "Override AI engine (claude, codex, copilot, custom)")
runCmd.Flags().StringP("repo", "r", "", "Target repository ([HOST/]owner/repo format). Defaults to current repository")
Expand Down
10 changes: 1 addition & 9 deletions pkg/cli/fix_command.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,7 @@ func NewFixCommand() *cobra.Command {
This command applies a registry of codemods that automatically update deprecated fields
and migrate to new syntax. Codemods preserve formatting and comments as much as possible.

Available codemods:
• timeout-minutes-migration: Replaces 'timeout_minutes' with 'timeout-minutes'
• network-firewall-migration: Removes deprecated 'network.firewall' field
• sandbox-false-to-agent-false: Converts 'sandbox: false' to 'sandbox.agent: false'
• safe-inputs-mode-removal: Removes deprecated 'safe-inputs.mode' field
• schedule-at-to-around-migration: Converts 'daily at TIME' to 'daily around TIME'
• delete-schema-file: Deletes deprecated .github/aw/schemas/agentic-workflow.json
• delete-old-agents: Deletes old workflow-specific .agent.md files from .github/agents/
• delete-old-templates: Removes old template files from pkg/cli/templates/
Use --list-codemods to see all available codemods and their descriptions.

If no workflows are specified, all Markdown files in .github/workflows will be processed.

Expand Down
6 changes: 3 additions & 3 deletions pkg/cli/project_command.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,9 @@ Authentication Requirements:
See https://github.github.com/gh-aw/reference/auth/.

Project Setup:
Use --with-project-setup to automatically create:
- Standard views (Progress Board, Task Tracker, Roadmap)
- Custom fields (Tracker Id, Worker Workflow, Target Repo, Priority, Size, dates)
Use --with-project-setup to automatically create:
- Standard views (Progress Board, Task Tracker, Roadmap)
- Custom fields (Tracker Id, Worker Workflow, Target Repo, Priority, Size, dates)
- Enhanced Status field with "Review Required" option

Examples:
Expand Down
4 changes: 2 additions & 2 deletions pkg/cli/trial_command.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ Repository mode examples:
` + string(constants.CLIExtensionPrefix) + ` trial githubnext/agentics/my-workflow --clone-repo myorg/myrepo # Clone myorg/myrepo contents into host

Repeat and cleanup examples:
` + string(constants.CLIExtensionPrefix) + ` trial githubnext/agentics/my-workflow --repeat 3 # Run 3 times total
` + string(constants.CLIExtensionPrefix) + ` trial githubnext/agentics/my-workflow --repeat 3 # Run 4 times total (1 initial + 3 repeats)
` + string(constants.CLIExtensionPrefix) + ` trial githubnext/agentics/my-workflow --delete-host-repo-after # Delete repo after completion
` + string(constants.CLIExtensionPrefix) + ` trial githubnext/agentics/my-workflow --host-repo my-trial # Custom host repo
` + string(constants.CLIExtensionPrefix) + ` trial githubnext/agentics/my-workflow --dry-run # Show what would be done without changes
Expand Down Expand Up @@ -187,7 +187,7 @@ Trial results are saved both locally (in trials/ directory) and in the host repo
cmd.Flags().Bool("dry-run", false, "Show what would be done without making any changes")
cmd.Flags().Int("timeout", 30, "Execution timeout in minutes (default: 30)")
cmd.Flags().String("trigger-context", "", "Trigger context URL (e.g., GitHub issue URL) for issue-triggered workflows")
cmd.Flags().Int("repeat", 0, "Number of times to repeat running workflows (0 = run once)")
cmd.Flags().Int("repeat", 0, "Number of additional times to run after the initial execution (e.g., --repeat 3 runs 4 times total)")
cmd.Flags().Bool("auto-merge-prs", false, "Auto-merge any pull requests created during trial execution")
addEngineFlag(cmd)
cmd.Flags().String("append", "", "Append extra content to the end of agentic workflow on installation")
Expand Down