[cli-consistency] Inconsistent terminology: "workflow-id" vs "workflow-name" vs "workflow-base-name" #4194
Description
Issue Description
Type: Inconsistent terminology in CLI command help text
Priority: Medium
Commands Affected: logs, enable, disable, run, remove, new, update
Current Behavior
The CLI uses inconsistent terminology when referring to workflows in command arguments:
Commands using "workflow-id":
logs [workflow-id]enable [workflow-id]...disable [workflow-id]...run (workflow-id)...update [workflow-id]...
Commands using other terms:
remove [pattern]- uses "pattern"new [workflow-base-name]- uses "workflow-base-name"
Explanation in help text:
The logs command Long description explains: "The workflow-id is the basename of the markdown file without the .md extension."
Expected Behavior
Consistent terminology across all CLI commands. Choose one term and use it everywhere:
- Option 1: "workflow-id" (currently most common)
- Option 2: "workflow-name" (more intuitive)
- Option 3: "workflow" (shortest)
Suggested Fix
Recommended approach: Standardize on "workflow-id" since it's already used in most commands.
Changes needed:
- new command: Change
[workflow-base-name]to[workflow-id] - remove command: Consider changing
[pattern]to[workflow-id-pattern]or keep as-is if it accepts regex patterns - Documentation: Add a global note explaining that "workflow-id" is the basename of the .md file without extension
Alternative approach:
If "workflow-name" is preferred, update all commands to use this term instead.
Additional Context
This inconsistency may cause confusion for users trying to understand what argument to provide to different commands. Standardizing the terminology will improve the user experience and make the CLI more intuitive.
Source Code References:
cmd/gh-aw/main.go- lines 52, 107, 123, 142, 254, etc.pkg/cli/logs.go- line 298pkg/cli/update_command.go- line 24
AI generated by CLI Consistency Checker