admin/github-spec-kit
1
0
Fork 0
mirror of https://github.com/github/spec-kit synced 2026-06-21 13:51:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: keep source install as primary, PyPI as alternative

Browse Source 
Until PyPI ownership is fully transferred and first publish is
confirmed, source installs from GitHub remain the primary recommended
method. PyPI install is listed as a convenient alternative.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
Manfred Riem
2026-06-18 07:38:47 -05:00
parent 9da00e3774
commit f80a18a893
3 changed files with 15 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/workflows/release.yml
+3 -7
View File
@@ -65,21 +65,17 @@ jobs:
cat > release_notes.md << NOTES_EOF
## Install
From [PyPI](https://pypi.org/project/specify-cli/):
\`\`\`bash
uv tool install 'specify-cli==${VERSION_NO_V}'
uv tool install specify-cli --from git+https://github.com/github/spec-kit.git@${VERSION}
specify init my-project
\`\`\`
Or install from source:
Or from [PyPI](https://pypi.org/project/specify-cli/) (may lag briefly after release):
\`\`\`bash
uv tool install specify-cli --from git+https://github.com/github/spec-kit.git@${VERSION}
uv tool install 'specify-cli==${VERSION_NO_V}'
\`\`\`
> **Note:** The PyPI package is published after this GitHub release. If the version is not yet available on PyPI, use the source install above.
NOTES_EOF
echo "## What's Changed" >> release_notes.md
README.md
+7 -7
View File
@@ -44,18 +44,18 @@ Spec-Driven Development **flips the script** on traditional software development
### 1. Install Specify CLI
Requires **[uv](https://docs.astral.sh/uv/)** ([install uv](https://github.com/github/spec-kit/blob/main/docs/install/uv.md)):
```bash
uv tool install specify-cli@latest
```
Or install from source using a specific [release](https://github.com/github/spec-kit/releases) tag (useful if the PyPI version is not yet available for a new release):
Requires **[uv](https://docs.astral.sh/uv/)** ([install uv](https://github.com/github/spec-kit/blob/main/docs/install/uv.md)). Replace `vX.Y.Z` with the latest tag from [Releases](https://github.com/github/spec-kit/releases):
```bash
uv tool install specify-cli --from git+https://github.com/github/spec-kit.git@vX.Y.Z
```
Or install from [PyPI](https://pypi.org/project/specify-cli/) (may lag briefly after a new release):
```bash
uv tool install specify-cli@latest
```
See the [Installation Guide](https://github.com/github/spec-kit/blob/main/docs/installation.md) for alternative methods, verification, upgrade, and troubleshooting.
### 2. Initialize a project
docs/installation.md
+5 -5
View File
@@ -11,23 +11,23 @@
## Installation
> [!NOTE]
> The official `specify-cli` package is published to [PyPI](https://pypi.org/project/specify-cli/) by the [github/spec-kit](https://github.com/github/spec-kit) maintainers. PyPI publishing is performed after each GitHub release and may lag briefly. Source installs from the GitHub repository are always available immediately.
> The `specify-cli` package is also available on [PyPI](https://pypi.org/project/specify-cli/), published by the [github/spec-kit](https://github.com/github/spec-kit) maintainers. PyPI publishing is performed after each GitHub release and may lag briefly. Source installs from the GitHub repository are always available immediately.
### Persistent Installation (Recommended)
Install once and use everywhere:
Install once and use everywhere. Replace `vX.Y.Z` with a tag from [Releases](https://github.com/github/spec-kit/releases):
> [!NOTE]
> The command below requires **[uv](https://docs.astral.sh/uv/)**. If you see `command not found: uv`, [install uv first](./install/uv.md).
```bash
uv tool install specify-cli@latest
uv tool install specify-cli --from git+https://github.com/github/spec-kit.git@vX.Y.Z
```
Or install from source using a specific [release](https://github.com/github/spec-kit/releases) tag:
Or install from PyPI:
```bash
uv tool install specify-cli --from git+https://github.com/github/spec-kit.git@vX.Y.Z
uv tool install specify-cli@latest
```
Then initialize a project: