Skip to content

Commit 1db65aa

Browse files
committed
feat: add uv tool install instructions to README
- Add persistent installation option using 'uv tool install' - Keep existing 'uvx' one-time usage option - Add benefits section explaining advantages of persistent installation - Reorganize installation section with clear option headers Fixes #476
1 parent 9348c45 commit 1db65aa

1 file changed

Lines changed: 27 additions & 1 deletion

File tree

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,38 @@ Spec-Driven Development **flips the script** on traditional software development
3939

4040
### 1. Install Specify
4141

42-
Initialize your project depending on the coding agent you're using:
42+
Choose your preferred installation method:
43+
44+
#### Option 1: Persistent Installation (Recommended)
45+
46+
Install once and use everywhere:
47+
48+
```bash
49+
uv tool install specify-cli --from git+https://github.com/github/spec-kit.git
50+
```
51+
52+
Then use the tool directly:
53+
54+
```bash
55+
specify init <PROJECT_NAME>
56+
specify check
57+
```
58+
59+
#### Option 2: One-time Usage
60+
61+
Run directly without installing:
4362

4463
```bash
4564
uvx --from git+https://github.com/github/spec-kit.git specify init <PROJECT_NAME>
4665
```
4766

67+
**Benefits of persistent installation:**
68+
69+
- Tool stays installed and available in PATH
70+
- No need to create shell aliases
71+
- Better tool management with `uv tool list`, `uv tool upgrade`, `uv tool uninstall`
72+
- Cleaner shell configuration
73+
4874
### 2. Establish project principles
4975

5076
Use the **`/constitution`** command to create your project's governing principles and development guidelines that will guide all subsequent development.

0 commit comments

Comments
 (0)