Skip to content

[cli-consistency] Inconsistent capitalization of "agentic workflows" in command descriptions #3711

@github-actions

Description

@github-actions

Issue Description

Type: Style inconsistency
Priority: Low
Scope: Multiple command Short descriptions

Current State

Command descriptions in the CLI use inconsistent capitalization when referring to "agentic workflows" and the product "Agentic Workflows".

Examples of Inconsistency

Lowercase "agentic workflows" (generic usage):

  • enable command: "Enable agentic workflows"
  • disable command: "Disable agentic workflows and cancel any in-progress runs"
  • status command: "Show status of agentic workflows"
  • init command: "Initialize repository for agentic workflows"
  • logs command: "Download and analyze agentic workflow logs with aggregated metrics"

Capitalized "Agentic Workflows" (product name):

  • Root command: "GitHub Agentic Workflows CLI from GitHub Next"

Capitalized technical terms:

  • compile command: "Compile Markdown to YAML workflows"
  • Uses "Markdown" and "YAML" capitalized (correct for proper nouns/acronyms)

Issue

The inconsistency makes it unclear whether:

  1. "Agentic Workflows" should always be capitalized as a product name
  2. "agentic workflows" should be lowercase when used generically
  3. There's a mixed approach depending on context

Recommendation

Choose one of these approaches and apply it consistently:

Option 1 - Always capitalize as product name:

Enable Agentic Workflows
Disable Agentic Workflows and cancel any in-progress runs
Show status of Agentic Workflows
Initialize repository for Agentic Workflows

Option 2 - Capitalize only when explicitly referring to the product:

Enable agentic workflows (generic usage - lowercase)
GitHub Agentic Workflows CLI (product name - capitalized)

Option 3 - Use "workflows" generically, "Agentic Workflows" for product:

Enable workflows
Disable workflows and cancel any in-progress runs
Show workflow status
Initialize repository for agentic workflows

Suggested Approach

Option 2 seems most appropriate:

  • Use lowercase "agentic workflows" when referring generically to the workflow files/functionality
  • Use capitalized "Agentic Workflows" only when explicitly referring to the product as a whole
  • Keep technical terms like "Markdown", "YAML", "MCP" capitalized

Files Affected

  • cmd/gh-aw/main.go - enable, disable commands
  • pkg/cli/status.go - status command
  • pkg/cli/init.go - init command (via init_command.go)
  • pkg/cli/logs.go - logs command

Impact

This is a minor style issue that doesn't affect functionality, but consistency in messaging improves the professional appearance of the CLI and makes it easier to understand when referring to the product vs. the concept.

AI generated by CLI Consistency Checker

Metadata

Metadata

Assignees

Labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions