Skip to content

[cli-consistency] Inconsistent placeholder: trial command uses <workflow> instead of <workflow-id> #5856

Description

@github-actions

Issue Description

Command: gh aw trial
Type: Inconsistent parameter naming
Priority: Low

Current Behavior

The trial command uses (workflow) as the parameter placeholder:

From trial_command.go line 44:

cmd := &cobra.Command{
    Use:   "trial (workflow)...",  // ← Uses "workflow"
    Short: "Trial one or more agentic workflows as if they were running in a repository",
    // ...
}

Issue

All other commands that accept workflow identifiers use consistent naming:

  • Most common: [workflow-id] - used by enable, disable, update, status, new, etc.
  • Alternative: [workflow-id-or-file] - used by MCP commands for more flexibility
  • Run command: (workflow-id) (required parameter)

The trial command is the only one using just (workflow) which breaks the pattern.

Why This Matters

Looking at the examples in the trial command, it accepts workflow specifications like:

  • githubnext/agentics/weekly-research (repository/workflow format)
  • ./local-workflow.md (file path)

So it's more than just a workflow-id, but it should still follow the naming convention used by other commands.

Suggested Fix

Option 1 (Best for consistency):

Use:   "trial (workflow-spec)...",

Option 2 (Match existing patterns):

Use:   "trial (workflow-id-or-spec)...",

The first option is cleaner and the Long description already explains what workflow specifications are accepted.

AI generated by CLI Consistency Checker

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions