From f80a18a89385dbf3fc1fb4280e0201bc5ab5a345 Mon Sep 17 00:00:00 2001 From: Manfred Riem Date: Thu, 18 Jun 2026 07:38:47 -0500 Subject: [PATCH] fix: keep source install as primary, PyPI as alternative 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> --- .github/workflows/release.yml | 10 +++------- README.md | 14 +++++++------- docs/installation.md | 10 +++++----- 3 files changed, 15 insertions(+), 19 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 6932d95e6..8b7839f02 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -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 diff --git a/README.md b/README.md index 44ec94bf8..0d89538da 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/installation.md b/docs/installation.md index 92cf1f0f4..c44c3570f 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -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: