From 82c078bb3ab7e6f66a334b27f0f4f596b31880a8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Emre=20De=C4=9Firmenci?= Date: Mon, 13 Jul 2026 18:27:18 +0300 Subject: [PATCH] docs: clarify that release tags keep the leading v prefix (#3463) Readers were replacing vX.Y.Z with bare versions like 0.12.11, which fails because git tags are named v0.12.11. Assisted-by: Cursor Grok 4.5 (supervised) Co-authored-by: Cursor --- README.md | 2 +- docs/install/one-time.md | 3 ++- docs/install/pipx.md | 3 ++- docs/installation.md | 2 +- 4 files changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index c759f6e05..138690529 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ Spec-Driven Development **flips the script** on traditional software development ### 1. Install Specify CLI -Requires **[uv](https://docs.astral.sh/uv/)** ([install uv](./docs/install/uv.md)). Replace `vX.Y.Z` with the latest tag from [Releases](https://github.com/github/spec-kit/releases): +Requires **[uv](https://docs.astral.sh/uv/)** ([install uv](./docs/install/uv.md)). Replace `vX.Y.Z` with the latest release tag from [Releases](https://github.com/github/spec-kit/releases) — keep the leading `v` (for example, `v0.12.11`, not `0.12.11`): ```bash uv tool install specify-cli --from git+https://github.com/github/spec-kit.git@vX.Y.Z diff --git a/docs/install/one-time.md b/docs/install/one-time.md index 134cb0b11..ed8bdef4e 100644 --- a/docs/install/one-time.md +++ b/docs/install/one-time.md @@ -11,7 +11,8 @@ If you want to try Spec Kit without installing it permanently, use `uvx` to run # Create a new project (latest from main) uvx --from git+https://github.com/github/spec-kit.git specify init -# Or target a specific release (replace vX.Y.Z with a tag from Releases) +# Or target a specific release (replace vX.Y.Z with a tag from Releases; +# keep the leading v, e.g. v0.12.11 not 0.12.11) uvx --from git+https://github.com/github/spec-kit.git@vX.Y.Z specify init # Initialize in the current directory diff --git a/docs/install/pipx.md b/docs/install/pipx.md index 3a25b1648..8e64ee083 100644 --- a/docs/install/pipx.md +++ b/docs/install/pipx.md @@ -7,7 +7,8 @@ Pin a specific release tag for stability (check [Releases](https://github.com/github/spec-kit/releases) for the latest): ```bash -# Install a specific stable release (recommended — replace vX.Y.Z with the latest tag) +# Install a specific stable release (recommended — replace vX.Y.Z with the +# latest tag, keeping the leading v, e.g. v0.12.11 not 0.12.11) pipx install git+https://github.com/github/spec-kit.git@vX.Y.Z # Or install latest from main (may include unreleased changes) diff --git a/docs/installation.md b/docs/installation.md index 744423b29..509c35382 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -15,7 +15,7 @@ ### Persistent Installation (Recommended) -Install once and use everywhere. Replace `vX.Y.Z` with a tag from [Releases](https://github.com/github/spec-kit/releases): +Install once and use everywhere. Replace `vX.Y.Z` with a release tag from [Releases](https://github.com/github/spec-kit/releases) — keep the leading `v` (for example, `v0.12.11`, not `0.12.11`): > [!NOTE] > The command below requires **[uv](https://docs.astral.sh/uv/)**. If you see `command not found: uv`, [install uv first](./install/uv.md).