Skip to content

[cli-consistency] Missing documentation for "version" command in CLI reference #3695

@github-actions

Description

@github-actions

Issue Description

Command: gh aw version
Type: Missing documentation
Priority: Low (documentation gap)

Problem

The version command exists in the CLI source code but is not documented in the CLI reference documentation.

Source Code (cmd/gh-aw/main.go:232-239):

var versionCmd = &cobra.Command{
	Use:   "version",
	Short: "Show version information",
	Run: func(cmd *cobra.Command, args []string) {
		fmt.Println(console.FormatInfoMessage(fmt.Sprintf("%s version %s", constants.CLIExtensionPrefix, version)))
		fmt.Println(console.FormatInfoMessage("GitHub Agentic Workflows CLI from GitHub Next"))
	},
}

Documentation: The command is added to root in main.go:382 but is not mentioned in docs/src/content/docs/setup/cli.md

Current State

  • Users can run gh aw version to see version information
  • The --version flag is mentioned in documentation
  • But the version subcommand itself is not documented

Suggested Fix

Add a "version" command entry to the CLI documentation at docs/src/content/docs/setup/cli.md, perhaps in a "Utility Commands" or similar section:

#### `version`

Show version information for the gh-aw CLI.

\`\`\`bash wrap
gh aw version
\`\`\`

Displays the current version of gh-aw and product information. Equivalent to using the `--version` flag.

Files to Modify

  • docs/src/content/docs/setup/cli.md (add version command documentation)

Note

The documentation mentions --version flag in the examples but doesn't document the version subcommand explicitly. Both work, but the subcommand should be documented for completeness.

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