docs(install): add pipx as alternative installation method#2288
docs(install): add pipx as alternative installation method#2288D7x7z49 wants to merge 1 commit intogithub:mainfrom
Conversation
- 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: github#2255
There was a problem hiding this comment.
Pull request overview
Updates Spec Kit documentation to present pipx as a supported alternative to uv/uvx for persistent CLI installation, reducing user confusion about installation options.
Changes:
- Add
pipx install ...examples alongside existinguv/uvxinstall guidance. - Add
pipx-based upgrade instructions in the upgrade guide. - Add notes in installation/quickstart docs to call out pipx compatibility.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adds pipx commands as an alternative persistent installation method. |
| docs/installation.md | Adds a note that pipx works for persistent installation and explains uv isn’t required by the build backend. |
| docs/quickstart.md | Adds a note suggesting pipx for persistent CLI installation. |
| docs/upgrade.md | Adds a pipx-specific CLI upgrade command. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 4/4 changed files
- Comments generated: 4
| # 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 |
There was a problem hiding this comment.
Adding pipx as an alternative install method here makes the later ## 🔧 Prerequisites section (which currently lists uv as required) and the later “Quick upgrade” snippet (uv-only) feel inconsistent for pipx users. Suggest updating those sections to either list pipx as an alternative prerequisite and/or include a pipx quick-upgrade command to match this install guidance.
| > [!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. |
There was a problem hiding this comment.
The note says pipx works equally well for a persistent install, but the Prerequisites section above still lists uv as required. This is contradictory for readers who want to use pipx instead of uv. Suggest updating prerequisites to indicate uv is recommended but optional when using pipx, or reword the note to clarify that uv is still required for the uvx commands shown in this guide.
| > You can also install the CLI persistently with `pipx`: | ||
| > ```bash | ||
| > pipx install git+https://github.com/github/spec-kit.git | ||
| > ``` |
There was a problem hiding this comment.
This note adds a pipx install command, but it doesn't explain how to use the persistent installation afterward (e.g., that users can run specify init ... directly instead of uvx --from ... specify init ...). Adding that follow-up would prevent confusion about why both installation approaches are shown.
| > ``` | |
| > ``` | |
| > After installing with `pipx`, run `specify` directly instead of `uvx --from ... specify`, for example: | |
| > ```bash | |
| > specify init <PROJECT_NAME> | |
| > specify init . | |
| > ``` |
| ### 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 | ||
| ``` |
There was a problem hiding this comment.
Now that pipx is documented as an installation method, the Quick Reference table at the top still only provides the uv tool install upgrade command. Consider adding a pipx equivalent (or a pointer) so pipx users can find the right command without scrolling/searching.
mnriem
left a comment
mnriem
left a comment
There was a problem hiding this comment.
Please address Copilot feedback. If not applicable, please explain why
Description
Adds
pipxas an equally valid alternative installation method touvin all relevant documentation files, addressing user confusion raised in Discussion #2255.Changes: