Skip to content

docs: Add missing documentation for version command#3700

Merged
pelikhan merged 2 commits intomainfrom
copilot/add-version-command-documentation
Nov 12, 2025
Merged

docs: Add missing documentation for version command#3700
pelikhan merged 2 commits intomainfrom
copilot/add-version-command-documentation

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Nov 12, 2025

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

Changes

  • Added "Utility Commands" section to docs/src/content/docs/setup/cli.md
  • Documented version command with usage example and flag equivalence note
### Utility Commands

#### `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.

The command was already implemented in cmd/gh-aw/main.go:232-239 and registered at line 382, but missing from user-facing documentation.

Original prompt

This section details on the original issue you should resolve

<issue_title>[cli-consistency] Missing documentation for "version" command in CLI reference</issue_title>
<issue_description>## 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</issue_description>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Add documentation for version command in CLI reference docs: Add missing documentation for version command Nov 12, 2025
Copilot AI requested a review from pelikhan November 12, 2025 06:37
@pelikhan pelikhan marked this pull request as ready for review November 12, 2025 06:38
Copilot AI review requested due to automatic review settings November 12, 2025 06:38
@pelikhan pelikhan merged commit 28fb80a into main Nov 12, 2025
96 of 100 checks passed
@pelikhan pelikhan deleted the copilot/add-version-command-documentation branch November 12, 2025 06:40
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds missing documentation for the version command that was implemented in the CLI but not documented in the user-facing reference.

  • Added a new "Utility Commands" section to the CLI documentation
  • Documented the version command with usage example and flag equivalence note

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

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

3 participants