Skip to content

Commit 82c078b

Browse files
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 <cursoragent@cursor.com>
1 parent 86d769b commit 82c078b

4 files changed

Lines changed: 6 additions & 4 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Spec-Driven Development **flips the script** on traditional software development
4545

4646
### 1. Install Specify CLI
4747

48-
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):
48+
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`):
4949

5050
```bash
5151
uv tool install specify-cli --from git+https://github.com/github/spec-kit.git@vX.Y.Z

docs/install/one-time.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@ If you want to try Spec Kit without installing it permanently, use `uvx` to run
1111
# Create a new project (latest from main)
1212
uvx --from git+https://github.com/github/spec-kit.git specify init <PROJECT_NAME>
1313

14-
# Or target a specific release (replace vX.Y.Z with a tag from Releases)
14+
# Or target a specific release (replace vX.Y.Z with a tag from Releases;
15+
# keep the leading v, e.g. v0.12.11 not 0.12.11)
1516
uvx --from git+https://github.com/github/spec-kit.git@vX.Y.Z specify init <PROJECT_NAME>
1617

1718
# Initialize in the current directory

docs/install/pipx.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
Pin a specific release tag for stability (check [Releases](https://github.com/github/spec-kit/releases) for the latest):
88

99
```bash
10-
# Install a specific stable release (recommended — replace vX.Y.Z with the latest tag)
10+
# Install a specific stable release (recommended — replace vX.Y.Z with the
11+
# latest tag, keeping the leading v, e.g. v0.12.11 not 0.12.11)
1112
pipx install git+https://github.com/github/spec-kit.git@vX.Y.Z
1213

1314
# Or install latest from main (may include unreleased changes)

docs/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
1616
### Persistent Installation (Recommended)
1717

18-
Install once and use everywhere. Replace `vX.Y.Z` with a tag from [Releases](https://github.com/github/spec-kit/releases):
18+
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`):
1919

2020
> [!NOTE]
2121
> The command below requires **[uv](https://docs.astral.sh/uv/)**. If you see `command not found: uv`, [install uv first](./install/uv.md).

0 commit comments

Comments
 (0)