docs(install): add pipx as alternative installation method#2288
docs(install): add pipx as alternative installation method#2288D7x7z49 wants to merge 2 commits 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
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
…grade references for pipx
update ok. @mnriem |
There was a problem hiding this comment.
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: 2
| > specify init . | ||
| > ``` | ||
|
|
||
|
|
There was a problem hiding this comment.
There are two consecutive blank lines after the new pipx NOTE block (after the blockquote ends). markdownlint’s MD012 (enabled in this repo) flags multiple consecutive blank lines; please collapse this to a single blank line before the next paragraph.
| | What to Upgrade | Command | When to Use | | ||
| |----------------|---------|-------------| | ||
| | **CLI Tool Only** | `uv tool install specify-cli --force --from git+https://github.com/github/spec-kit.git@vX.Y.Z` | Get latest CLI features without touching project files | | ||
| | **pipx upgrade** | `pipx install --force git+https://github.com/github/spec-kit.git@vX.Y.Z` | Upgrade pipx-installed CLI | |
There was a problem hiding this comment.
In the Quick Reference table, the label “pipx upgrade” is misleading because the command shown is pipx install --force ... (a reinstall). Consider renaming this row to match the other rows’ “What to Upgrade” phrasing (e.g., “CLI Tool Only (pipx)”) and/or clarify that this is the pipx reinstall/upgrade path.
| | **pipx upgrade** | `pipx install --force git+https://github.com/github/spec-kit.git@vX.Y.Z` | Upgrade pipx-installed CLI | | |
| | **CLI Tool Only (pipx)** | `pipx install --force git+https://github.com/github/spec-kit.git@vX.Y.Z` | Reinstall/upgrade a pipx-installed CLI to a specific release | |
mnriem
left a comment
mnriem
left a comment
There was a problem hiding this comment.
Please address Copilot feedback
Description
Adds
pipxas an equally valid alternative installation method touvin all relevant documentation files, addressing user confusion raised in Discussion #2255.Changes: