Skip to content

fix(cli): correct misleading docs and remove nonexistent --version hint#323

Open
alfredo-petri wants to merge 1 commit into
nextlevelbuilder:mainfrom
alfredo-petri:fix/cli-docs-accuracy
Open

fix(cli): correct misleading docs and remove nonexistent --version hint#323
alfredo-petri wants to merge 1 commit into
nextlevelbuilder:mainfrom
alfredo-petri:fix/cli-docs-accuracy

Conversation

@alfredo-petri

Copy link
Copy Markdown
Contributor

Problem

Two pieces of documentation describe behavior that doesn't match the code:

1. cli/README.md — wrong install mechanism

"By default, uipro init tries to download the latest release from GitHub..."

The current default path (init.ts:179-183) uses generatePlatformFiles() — template generation from bundled assets. GitHub download only happens in the legacy ZIP mode (init.ts:160), which is not exposed as a CLI option. So --offline is currently a no-op relative to the default.

2. cli/src/commands/versions.ts:34 — advertises a nonexistent flag

Use: uipro init --version <tag> to install a specific version

--version is not a registered option in index.ts for the init command. Running this would either use Commander's built-in --version (prints CLI version) or fail silently.

Fix

  • Rewrite "How It Works" in README to accurately describe template-based generation
  • Replace the nonexistent --version hint in versions.ts with an accurate tip

🤖 Generated with Claude Code

cli/README.md described uipro init as downloading from GitHub by default.
The current code uses template generation from bundled assets — GitHub is
only used in the legacy ZIP mode which is not exposed as a CLI option.

versions.ts advertised `uipro init --version <tag>` which is not a
registered Commander option and does not work.

- Rewrite How It Works section to match actual template-based behavior
- Replace nonexistent --version hint with accurate usage tip

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

@mrgoonie mrgoonie left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Summary: This PR correctly removes the nonexistent uipro init --version <tag> hint, but the README rewrite goes too far and now makes --offline look like a no-op even though it still changes behavior in the legacy ZIP install path.

Risk level: Medium

Mandatory gates:

  • Duplicate/prior implementation: no merged duplicate found; search found this PR plus broader CLI/release PRs, but no prior fix for the exact --version hint + README wording.
  • Project standards: issue found — CLI docs should describe both default template mode and the remaining legacy/offline behavior accurately.
  • Strategic necessity: clear value — avoiding nonexistent CLI flags and stale install docs reduces support churn.
  • CI/checks: missing/not reported for this PR.

Findings:

  • Important: cli/src/commands/init.ts still has a legacy ZIP-based install branch where options.offline skips the GitHub release download and falls back to bundled assets (if (options.legacy) { ... if (!options.offline) tryGitHubInstall(...) ... copyFolders(...) }). The PR README says --offline is a no-op with the current default, but the public CLI no longer exposes --legacy in cli/src/index.ts, so this wording is confusing from both directions: it documents internal behavior without explaining that the GitHub-download path is legacy-only/inaccessible from current public options. Please adjust the README/help text so it is precise, e.g. default init uses bundled template generation; --offline is retained for compatibility and only affects legacy/package paths if those are exposed, or remove/clarify the flag separately.

Verdict: REQUEST_CHANGES

@mrgoonie mrgoonie added agent:github-maintain Processed by github-maintain automation pr:reviewed PR reviewed by maintain workflow pr:changes-requested Maintain review requested changes labels Jun 21, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

agent:github-maintain Processed by github-maintain automation pr:changes-requested Maintain review requested changes pr:reviewed PR reviewed by maintain workflow

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants