Skip to content

Commit 72e2a53

Browse files
iamaeroplaneclaude
andcommitted
docs: warn about unofficial PyPI packages and recommend version verification (#1982)
Clarify that only packages from github/spec-kit are official, and add `specify version` as a post-install verification step to help users catch accidental installation of an unrelated package with the same name. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 94ba857 commit 72e2a53

2 files changed

Lines changed: 19 additions & 1 deletion

File tree

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ Spec-Driven Development **flips the script** on traditional software development
5050

5151
Choose your preferred installation method:
5252

53+
> **Important:** The only official, maintained packages for Spec Kit are published from this GitHub repository. Any packages with the same name on PyPI are **not** affiliated with this project and are not maintained by the Spec Kit maintainers. Always install directly from GitHub as shown below.
54+
5355
#### Option 1: Persistent Installation (Recommended)
5456

5557
Install once and use everywhere. Pin a specific release tag for stability (check [Releases](https://github.com/github/spec-kit/releases) for the latest):
@@ -62,7 +64,13 @@ uv tool install specify-cli --from git+https://github.com/github/spec-kit.git@vX
6264
uv tool install specify-cli --from git+https://github.com/github/spec-kit.git
6365
```
6466

65-
Then use the tool directly:
67+
Then verify the correct version is installed:
68+
69+
```bash
70+
specify version
71+
```
72+
73+
And use the tool directly:
6674

6775
```bash
6876
# Create new project

docs/installation.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010

1111
## Installation
1212

13+
> **Important:** The only official, maintained packages for Spec Kit are published from the [github/spec-kit](https://github.com/github/spec-kit) GitHub repository. Any packages with the same name available on PyPI (e.g. `specify-cli` on pypi.org) are **not** affiliated with this project and are not maintained by the Spec Kit maintainers. Always install directly from GitHub as shown below.
14+
1315
### Initialize a New Project
1416

1517
The easiest way to get started is to initialize a new project. Pin a specific release tag for stability (check [Releases](https://github.com/github/spec-kit/releases) for the latest):
@@ -69,6 +71,14 @@ uvx --from git+https://github.com/github/spec-kit.git@vX.Y.Z specify init <proje
6971

7072
## Verification
7173

74+
After installation, run the following command to confirm the correct version is installed:
75+
76+
```bash
77+
specify version
78+
```
79+
80+
This helps verify you are running the official Spec Kit build from GitHub, not an unrelated package with the same name.
81+
7282
After initialization, you should see the following commands available in your AI agent:
7383

7484
- `/speckit.specify` - Create specifications

0 commit comments

Comments
 (0)