Skip to content

Commit b278d66

Browse files
D7x7z49Copilot
andauthored
docs(install): add pipx as alternative installation method (#2288)
* 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: #2255 * docs(install): address Copilot feedback - update prerequisites and upgrade references for pipx * Update docs/quickstart.md markdownlint’s MD012 (enabled in this repo) flags multiple consecutive blank lines Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update docs/upgrade.md 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> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 709457c commit b278d66

4 files changed

Lines changed: 34 additions & 2 deletions

File tree

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,10 @@ uv tool install specify-cli --from git+https://github.com/github/spec-kit.git@vX
6262

6363
# Or install latest from main (may include unreleased changes)
6464
uv tool install specify-cli --from git+https://github.com/github/spec-kit.git
65+
66+
# Alternative: using pipx (also works)
67+
pipx install git+https://github.com/github/spec-kit.git@vX.Y.Z
68+
pipx install git+https://github.com/github/spec-kit.git
6569
```
6670

6771
Then verify the correct version is installed:
@@ -89,6 +93,7 @@ To upgrade Specify, see the [Upgrade Guide](./docs/upgrade.md) for detailed inst
8993

9094
```bash
9195
uv tool install specify-cli --force --from git+https://github.com/github/spec-kit.git@vX.Y.Z
96+
# pipx users: pipx install --force git+https://github.com/github/spec-kit.git@vX.Y.Z
9297
```
9398

9499
#### Option 2: One-time Usage
@@ -426,7 +431,7 @@ Our research and experimentation focus on:
426431

427432
- **Linux/macOS/Windows**
428433
- [Supported](#-supported-ai-coding-agent-integrations) AI coding agent.
429-
- [uv](https://docs.astral.sh/uv/) for package management
434+
- [uv](https://docs.astral.sh/uv/) for package management (recommended) or [pipx](https://pypa.github.io/pipx/) for persistent installation
430435
- [Python 3.11+](https://www.python.org/downloads/)
431436
- [Git](https://git-scm.com/downloads)
432437

docs/installation.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
- **Linux/macOS** (or Windows; PowerShell scripts now supported without WSL)
66
- AI coding agent: [Claude Code](https://www.anthropic.com/claude-code), [GitHub Copilot](https://code.visualstudio.com/), [Codebuddy CLI](https://www.codebuddy.ai/cli), [Gemini CLI](https://github.com/google-gemini/gemini-cli), or [Pi Coding Agent](https://pi.dev)
7-
- [uv](https://docs.astral.sh/uv/) for package management
7+
- [uv](https://docs.astral.sh/uv/) for package management (recommended) or [pipx](https://pypa.github.io/pipx/) for persistent installation
88
- [Python 3.11+](https://www.python.org/downloads/)
99
- [Git](https://git-scm.com/downloads)
1010

@@ -24,6 +24,13 @@ uvx --from git+https://github.com/github/spec-kit.git@vX.Y.Z specify init <PROJE
2424
uvx --from git+https://github.com/github/spec-kit.git specify init <PROJECT_NAME>
2525
```
2626

27+
> [!NOTE]
28+
> For a persistent installation, `pipx` works equally well:
29+
> ```bash
30+
> pipx install git+https://github.com/github/spec-kit.git@vX.Y.Z
31+
> ```
32+
> The project uses a standard `hatchling` build backend and has no uv-specific dependencies.
33+
2734
Or initialize in the current directory:
2835
2936
```bash

docs/quickstart.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,17 @@ uvx --from git+https://github.com/github/spec-kit.git specify init <PROJECT_NAME
2222
uvx --from git+https://github.com/github/spec-kit.git specify init .
2323
```
2424

25+
> [!NOTE]
26+
> You can also install the CLI persistently with `pipx`:
27+
> ```bash
28+
> pipx install git+https://github.com/github/spec-kit.git
29+
> ```
30+
> After installing with `pipx`, run `specify` directly instead of `uvx --from ... specify`, for example:
31+
> ```bash
32+
> specify init <PROJECT_NAME>
33+
> specify init .
34+
> ```
35+
2536
Pick script type explicitly (optional):
2637
2738
```bash

docs/upgrade.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
| What to Upgrade | Command | When to Use |
1010
|----------------|---------|-------------|
1111
| **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 |
12+
| **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 |
1213
| **Project Files** | `specify init --here --force --ai <your-agent>` | Update slash commands, templates, and scripts in your project |
1314
| **Both** | Run CLI upgrade, then project update | Recommended for major version updates |
1415

@@ -34,6 +35,14 @@ Specify the desired release tag:
3435
uvx --from git+https://github.com/github/spec-kit.git@vX.Y.Z specify init --here --ai copilot
3536
```
3637

38+
### If you installed with `pipx`
39+
40+
Upgrade to a specific release:
41+
42+
```bash
43+
pipx install --force git+https://github.com/github/spec-kit.git@vX.Y.Z
44+
```
45+
3746
### Verify the upgrade
3847

3948
```bash

0 commit comments

Comments
 (0)