From 6a0fc9f6895caa193bb4f4c26a6b465f3eb0a519 Mon Sep 17 00:00:00 2001 From: D7x7z49 <85430783+D7x7z49@users.noreply.github.com> Date: Tue, 21 Apr 2026 10:04:50 +0800 Subject: [PATCH] docs(install): add pipx as alternative installation method - Add pipx commands to README.md installation section - Add note about pipx compatibility to docs/installation.md - Mention pipx persistent installation in docs/quickstart.md - Add pipx upgrade instructions to docs/upgrade.md - Clarify that project has no uv-specific dependencies Refs: https://github.com/github/spec-kit/discussions/2255 --- README.md | 4 ++++ docs/installation.md | 7 +++++++ docs/quickstart.md | 6 ++++++ docs/upgrade.md | 8 ++++++++ 4 files changed, 25 insertions(+) diff --git a/README.md b/README.md index 38d319c9fa..6d91289070 100644 --- a/README.md +++ b/README.md @@ -62,6 +62,10 @@ uv tool install specify-cli --from git+https://github.com/github/spec-kit.git@vX # Or install latest from main (may include unreleased changes) uv tool install specify-cli --from git+https://github.com/github/spec-kit.git + +# Alternative: using pipx (also works) +pipx install git+https://github.com/github/spec-kit.git@vX.Y.Z +pipx install git+https://github.com/github/spec-kit.git ``` Then verify the correct version is installed: diff --git a/docs/installation.md b/docs/installation.md index ed253902af..0d37eda72b 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -24,6 +24,13 @@ uvx --from git+https://github.com/github/spec-kit.git@vX.Y.Z specify init ``` +> [!NOTE] +> For a persistent installation, `pipx` works equally well: +> ```bash +> pipx install git+https://github.com/github/spec-kit.git@vX.Y.Z +> ``` +> The project uses a standard `hatchling` build backend and has no uv-specific dependencies. + Or initialize in the current directory: ```bash diff --git a/docs/quickstart.md b/docs/quickstart.md index 4b2c3c8807..4be0dea814 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -22,6 +22,12 @@ uvx --from git+https://github.com/github/spec-kit.git specify init [!NOTE] +> You can also install the CLI persistently with `pipx`: +> ```bash +> pipx install git+https://github.com/github/spec-kit.git +> ``` + Pick script type explicitly (optional): ```bash diff --git a/docs/upgrade.md b/docs/upgrade.md index 020360d222..e51438e29a 100644 --- a/docs/upgrade.md +++ b/docs/upgrade.md @@ -34,6 +34,14 @@ Specify the desired release tag: uvx --from git+https://github.com/github/spec-kit.git@vX.Y.Z specify init --here --ai copilot ``` +### If you installed with `pipx` + +Upgrade to a specific release: + +```bash +pipx install --force git+https://github.com/github/spec-kit.git@vX.Y.Z +``` + ### Verify the upgrade ```bash