Skip to content

fix(cli): resolve 5 CLI consistency issues from automated inspection #22458

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

fix(cli): resolve 5 CLI consistency issues from automated inspection #22458

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0ae5831
Initial plan
Copilot Mar 23, 2026
9d6e539
fix(cli): address CLI consistency issues from 2026-03-23 inspection
Copilot Mar 23, 2026
0825cea
Merge branch 'main' into copilot/cli-consistency-fixes
pelikhan Mar 23, 2026
f2a9f13
Merge branch 'main' into copilot/cli-consistency-fixes
pelikhan Mar 23, 2026
a4e85e4
fix: update command group tests and add missing --repo/-r to add docs
Copilot Mar 23, 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
3 changes: 2 additions & 1 deletion cmd/gh-aw/command_groups_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ func TestCommandGroupAssignments(t *testing.T) {
// Development Commands
{name: "compile command in development group", commandName: "compile", expectedGroup: "development", shouldHaveGroup: true},
{name: "mcp command in development group", commandName: "mcp", expectedGroup: "development", shouldHaveGroup: true},
{name: "status command in development group", commandName: "status", expectedGroup: "development", shouldHaveGroup: true},
{name: "fix command in development group", commandName: "fix", expectedGroup: "development", shouldHaveGroup: true},

// Execution Commands
Expand All @@ -39,6 +38,8 @@ func TestCommandGroupAssignments(t *testing.T) {
// Analysis Commands
{name: "logs command in analysis group", commandName: "logs", expectedGroup: "analysis", shouldHaveGroup: true},
{name: "audit command in analysis group", commandName: "audit", expectedGroup: "analysis", shouldHaveGroup: true},
{name: "status command in analysis group", commandName: "status", expectedGroup: "analysis", shouldHaveGroup: true},
{name: "list command in analysis group", commandName: "list", expectedGroup: "analysis", shouldHaveGroup: true},

// Utilities
{name: "mcp-server command in utilities group", commandName: "mcp-server", expectedGroup: "utilities", shouldHaveGroup: true},
Expand Down
4 changes: 2 additions & 2 deletions cmd/gh-aw/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -745,10 +745,10 @@ Use "` + string(constants.CLIExtensionPrefix) + ` help all" to show help for all
compileCmd.GroupID = "development"
validateCmd.GroupID = "development"
mcpCmd.GroupID = "development"
statusCmd.GroupID = "development"
listCmd.GroupID = "development"
fixCmd.GroupID = "development"
domainsCmd.GroupID = "development"
statusCmd.GroupID = "analysis"
listCmd.GroupID = "analysis"
Comment on lines +750 to +751
Copy link

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

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

Changing status and list to the analysis group will break the existing integration test expectations in cmd/gh-aw/command_groups_test.go (it currently asserts status is in development). Please update that test (and consider adding an assertion for list) to match the new group IDs so CI stays green.

Suggested change
statusCmd.GroupID = "analysis"
listCmd.GroupID = "analysis"
statusCmd.GroupID = "development"
listCmd.GroupID = "development"

Copilot uses AI. Check for mistakes.

// Execution Commands
runCmd.GroupID = "execution"
Expand Down
10 changes: 5 additions & 5 deletions docs/src/content/docs/setup/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ gh aw add-wizard https://github.com/org/repo/blob/main/workflows/my-workflow.md
gh aw add-wizard githubnext/agentics/ci-doctor --skip-secret # Skip secret prompt
```

**Options:** `--skip-secret` (bypass the API key prompt when the secret is already configured at org or repo level)
**Options:** `--skip-secret`, `--dir/-d`, `--engine/-e`, `--no-gitattributes`, `--no-stop-after`, `--stop-after`

#### `add`

Expand All @@ -164,7 +164,7 @@ gh aw add ci-doctor --dir shared # Organize in subdirectory
gh aw add ci-doctor --create-pull-request # Create PR instead of commit
```

**Options:** `--dir`, `--create-pull-request`, `--no-gitattributes`
**Options:** `--dir/-d`, `--repo/-r`, `--create-pull-request`, `--no-gitattributes`, `--append`, `--disable-security-scanner`, `--engine/-e`, `--force/-f`, `--name/-n`, `--no-stop-after`, `--stop-after`

#### `new`

Expand Down Expand Up @@ -296,7 +296,7 @@ gh aw trial ./workflow.md --host-repo owner/repo # Run directly in repository
gh aw trial ./workflow.md --dry-run # Preview without executing
```

**Options:** `-e`, `--engine`, `--repeat`, `--delete-host-repo-after`, `--logical-repo`, `--clone-repo`, `--trigger-context`, `--host-repo`, `--dry-run`
**Options:** `-e/--engine`, `--repeat`, `--delete-host-repo-after`, `--logical-repo/-l`, `--clone-repo`, `--trigger-context`, `--host-repo`, `--dry-run`, `--append`, `--auto-merge-prs`, `--disable-security-scanner`, `--force-delete-host-repo-before`, `--timeout`, `--yes/-y`

**Secret Handling:** API keys required for the selected engine are automatically checked. If missing from the target repository, they are prompted for interactively and uploaded.

Expand All @@ -313,7 +313,7 @@ gh aw run workflow --push --ref main # Push to specific branch
gh aw run workflow --json # Output triggered workflow results as JSON
```

**Options:** `--repeat`, `--push` (see [--push flag](#the---push-flag)), `--ref`, `--enable-if-needed`, `--json/-j`
**Options:** `--repeat`, `--push` (see [--push flag](#the---push-flag)), `--ref`, `--enable-if-needed`, `--json/-j`, `--auto-merge-prs`, `--dry-run`, `--engine/-e`, `--raw-field/-F`, `--repo/-r`

When `--json` is set, a JSON array of triggered workflow results is written to stdout.

Expand Down Expand Up @@ -494,7 +494,7 @@ gh aw upgrade --audit # Run dependency health audit
gh aw upgrade --audit --json # Dependency audit in JSON format
```

**Options:** `--dir`, `--no-fix`, `--no-actions`, `--create-pull-request`, `--audit`, `--json`
**Options:** `--dir/-d`, `--no-fix`, `--no-actions`, `--no-compile`, `--create-pull-request`, `--audit`, `--json/-j`

### Advanced

Expand Down
2 changes: 1 addition & 1 deletion pkg/cli/fix_command.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Without --write (dry-run mode), no files are modified. With --write, the command
all steps and additionally:
4. Write updated files back to disk
5. Delete deprecated .github/aw/schemas/agentic-workflow.json file if it exists
6. Delete old template files from pkg/cli/templates/ if present
6. Delete old template files from previous versions if present
7. Delete old workflow-specific .agent.md files from .github/agents/ if present

` + WorkflowIDExplanation + `
Expand Down
6 changes: 3 additions & 3 deletions pkg/cli/tokens_bootstrap.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ func newSecretsBootstrapSubcommand() *cobra.Command {
cmd := &cobra.Command{
Use: "bootstrap",
Short: "Analyze workflows and set up required secrets",
Long: `Analyzes all workflows in the repository to determine which secrets
are required, checks which ones are already configured, and interactively
prompts for any missing required secrets.
Long: `Analyze all workflows in the repository to determine which secrets
are required, check which ones are already configured, and interactively
prompt for any missing required secrets.

This command:
- Discovers all workflow files in .github/workflows/
Expand Down
2 changes: 1 addition & 1 deletion pkg/cli/trial_command.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ Trial results are saved both locally (in trials/ directory) and in the host repo
}

// Add flags
cmd.Flags().StringP("logical-repo", "s", "", "The repo we're simulating the execution for, as if the workflow was installed in that repo (defaults to current repository)")
cmd.Flags().StringP("logical-repo", "l", "", "The repo we're simulating the execution for, as if the workflow was installed in that repo (defaults to current repository)")
cmd.Flags().String("clone-repo", "", "Alternative to --logical-repo: clone the contents of the specified repo into the host repo instead of using logical repository simulation")

cmd.Flags().String("host-repo", "", "Custom host repository slug (defaults to '<username>/gh-aw-trial'). Use '.' for current repository")
Expand Down