docs(install): add pipx as alternative installation method#2288
docs(install): add pipx as alternative installation method#2288mnriem merged 4 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
mnriem
left a comment
mnriem
left a comment
There was a problem hiding this comment.
Please address Copilot feedback
markdownlint’s MD012 (enabled in this repo) flags multiple consecutive blank lines Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
In the Quick Reference table, the label “pipx upgrade” is misleading because the command shown is `pipx install --force ...` (a reinstall). by copilot. Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
@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: 1
|
Thank you! |
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.
Comments suppressed due to low confidence (1)
docs/quickstart.md:34
- Same markdownlint MD031 issue for the second fenced code block in this
[!NOTE]blockquote: it should be surrounded by blank blockquote lines. Add>-prefixed blank lines around the fence (or convert to an indented code block) somarkdownlint-cli2passes.
> After installing with `pipx`, run `specify` directly instead of `uvx --from ... specify`, for example:
> ```bash
> specify init <PROJECT_NAME>
> specify init .
> ```
- Files reviewed: 4/4 changed files
- Comments generated: 1
Description
Adds
pipxas an equally valid alternative installation method touvin all relevant documentation files, addressing user confusion raised in Discussion #2255.Changes: