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
This commit is contained in:
Shayne Boyer
2025-09-22 11:08:25 -04:00
parent 9348c45f9e
commit 1db65aa6aa

View File

@@ -39,12 +39,38 @@ Spec-Driven Development **flips the script** on traditional software development
### 1. Install Specify ### 1. Install Specify
Initialize your project depending on the coding agent you're using: Choose your preferred installation method:
#### Option 1: Persistent Installation (Recommended)
Install once and use everywhere:
```bash
uv tool install specify-cli --from git+https://github.com/github/spec-kit.git
```
Then use the tool directly:
```bash
specify init <PROJECT_NAME>
specify check
```
#### Option 2: One-time Usage
Run directly without installing:
```bash ```bash
uvx --from git+https://github.com/github/spec-kit.git specify init <PROJECT_NAME> uvx --from git+https://github.com/github/spec-kit.git specify init <PROJECT_NAME>
``` ```
**Benefits of persistent installation:**
- Tool stays installed and available in PATH
- No need to create shell aliases
- Better tool management with `uv tool list`, `uv tool upgrade`, `uv tool uninstall`
- Cleaner shell configuration
### 2. Establish project principles ### 2. Establish project principles
Use the **`/constitution`** command to create your project's governing principles and development guidelines that will guide all subsequent development. Use the **`/constitution`** command to create your project's governing principles and development guidelines that will guide all subsequent development.