Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Jan 23, 2026

The upgrade command documentation incorrectly stated it "upgrades the gh-aw extension." The command only upgrades repository files (agent templates, workflows) and validates the extension version—it does not upgrade the extension itself.

Changes

  • Command description: Removed misleading "upgrade the gh-aw extension" text, clarified it upgrades repository agent files and workflows
  • Example comment: Changed "Upgrade extension and all workflows" → "Upgrade repository agent files and all workflows"

Context

The command checks if the extension is current (ensureLatestExtensionVersion) but prompts users to run gh extension upgrade githubnext/gh-aw separately if outdated. Documentation now matches implementation behavior in pkg/cli/upgrade_command.go.

Original prompt

This section details on the original issue you should resolve

<issue_title>[cli-consistency] Missing upgrade command in main CLI documentation</issue_title>
<issue_description>## Issue Description

Command: gh aw upgrade
Type: Documentation gap
Priority: Medium
Location: docs/src/content/docs/setup/cli.md

Current State

The upgrade command exists in source code (pkg/cli/upgrade_command.go) and is registered in main.go, but is not documented in the main CLI reference at docs/src/content/docs/setup/cli.md.

Command Details (from source)

Use:   "upgrade"
Short: "Upgrade repository with latest agent files and apply codemods to all workflows"
Long:  "Upgrade the repository for the latest version of agentic workflows."

Evidence

From cmd/gh-aw/main.go:

rootCmd.AddCommand(upgradeCmd)

From documentation search:

$ grep -i "upgrade" docs/src/content/docs/setup/cli.md
# Upgrade pinned version

Only mentions "upgrade" in context of upgrading the gh extension itself, not the gh aw upgrade command.

Impact

Users cannot discover the upgrade command through documentation, which is important for:

  • Upgrading repository agent files to latest versions
  • Applying codemods automatically to all workflows
  • Maintaining compatibility with new gh-aw features

Suggested Fix

Add documentation section for the upgrade command under the Management category (after update):

#### `upgrade`

Upgrade repository with latest agent files and apply codemods to all workflows.

```bash wrap
gh aw upgrade                              # Upgrade agent files and apply codemods
gh aw upgrade --verbose                    # Upgrade with detailed output
```

**Options:** `--verbose`

This command:
- Updates repository agent files to the latest version
- Applies all available codemods to workflows
- Ensures compatibility with the latest gh-aw features

Related Commands

AI generated by CLI Consistency Checker

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


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix missing upgrade command in CLI documentation Fix upgrade command documentation - clarify repository scope Jan 23, 2026
Copilot AI requested a review from pelikhan January 23, 2026 22:04
@pelikhan pelikhan marked this pull request as ready for review January 23, 2026 22:06
@pelikhan pelikhan merged commit 738f0da into main Jan 23, 2026
@pelikhan pelikhan deleted the copilot/fix-cli-documentation-upgrade-command branch January 23, 2026 22:06
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 upgrade command in main CLI documentation

2 participants