Skip to content

[cli-consistency] Missing upgrade command in main CLI documentation #11288

@github-actions

Description

@github-actions

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

Metadata

Metadata

Labels

automationclicookieIssue Monster Loves Cookies!documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions