docs: clarify CLI upgrade discovery#2519
Merged
mnriem merged 1 commit intoMay 12, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This docs-only PR clarifies how users can discover whether their locally installed specify CLI is outdated, and how to upgrade it when a newer feature (notably controlled multi-install integrations) is available in newer releases. It addresses the confusion where uvx --from git+... can run a newer Spec Kit version without updating the persistent specify executable on the user’s PATH.
Changes:
- Add
specify self checkas the recommended way to discover newer released CLI versions before upgrading. - Clarify that one-shot
uvxcommands run a temporary Spec Kit copy and do not upgrade a persistent CLI install. - Add an integrations reference note that controlled multi-install support requires Spec Kit ≥ 0.8.5 and point users to
specify version+ upgrade steps.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/upgrade.md | Adds pre-upgrade discovery (specify self check), explains uvx is temporary, and recommends specify version to verify what’s on PATH. |
| docs/reference/integrations.md | Documents the minimum Spec Kit version for controlled multi-install and clarifies the uvx vs persistent CLI distinction for troubleshooting. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
mnriem
approved these changes
May 12, 2026
Collaborator
|
Thank you! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Closes #2498.
Clarifies how to discover and upgrade local CLI capabilities when newer integration features are available. The integration reference now calls out that controlled multi-install requires Spec Kit 0.8.5 or newer and explains that one-shot
uvxcommands do not update the persistentspecifyexecutable. The upgrade guide now points users tospecify self check, explains the temporary nature ofuvx, and recommendsspecify versionto verify the CLI onPATH.Testing
uv run specify --helpuv sync && uv run pytestAdditional validation:
git diff --checknpx markdownlint-cli2 docs/reference/integrations.md docs/upgrade.mdAI Disclosure
Used AI assistance to inspect repository context, draft the documentation wording, and run local validation; the changes were reviewed before submission.