diff --git a/README.md b/README.md index 2ccc5d3fc0..0ebd129557 100644 --- a/README.md +++ b/README.md @@ -56,6 +56,9 @@ Choose your preferred installation method: Install once and use everywhere. Pin a specific release tag for stability (check [Releases](https://github.com/github/spec-kit/releases) for the latest): +> [!NOTE] +> The `uv tool install` commands below require **[uv](https://docs.astral.sh/uv/)** — a fast Python package manager. If you see `command not found: uv`, [install uv first](./docs/install/uv.md). The `pipx` alternative does not require uv. + ```bash # Install a specific stable release (recommended — replace vX.Y.Z with the latest tag) uv tool install specify-cli --from git+https://github.com/github/spec-kit.git@vX.Y.Z diff --git a/docs/install/uv.md b/docs/install/uv.md new file mode 100644 index 0000000000..21e6d23baf --- /dev/null +++ b/docs/install/uv.md @@ -0,0 +1,60 @@ +# Installing uv + +[uv](https://docs.astral.sh/uv/) is a fast Python package manager by [Astral](https://astral.sh/). Spec Kit uses `uv` (via `uvx` or `uv tool install`) to run the `specify` CLI without polluting your global Python environment. + +> [!NOTE] +> **Already have uv?** Run `uv --version` to confirm it is installed, then head back to the [Installation Guide](../installation.md). + +## Installation + +### macOS and Linux — Standalone Installer + +The quickest way to install uv on macOS or Linux is the official shell script: + +```bash +curl -LsSf https://astral.sh/uv/install.sh | sh +``` + +After the script finishes, follow any instructions printed by the installer to add uv to your `PATH`, then open a new terminal. + +### Windows — Standalone Installer + +Run the following in **Command Prompt or PowerShell**: + +```powershell +powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex" +``` + +After the script finishes, open a new terminal so the `uv` binary is on your `PATH`. + +### macOS — Homebrew + +```bash +brew install uv +``` + +### Windows — WinGet + +```powershell +winget install --id=astral-sh.uv -e +``` + +### Windows — Scoop + +```powershell +scoop install uv +``` + +## Verification + +Confirm that uv is installed and on your `PATH`: + +```bash +uv --version +``` + +You should see output similar to `uv 0.x.y (...)`. + +## Further Reading + +For advanced options (self-update, proxy settings, uninstall, etc.) see the official [uv installation docs](https://docs.astral.sh/uv/getting-started/installation/). diff --git a/docs/installation.md b/docs/installation.md index 7f6aa089b7..cafd6eb116 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -16,6 +16,9 @@ The easiest way to get started is to initialize a new project. Pin a specific release tag for stability (check [Releases](https://github.com/github/spec-kit/releases) for the latest): +> [!NOTE] +> The `uvx` commands below require **[uv](https://docs.astral.sh/uv/)**. If you see `command not found: uvx`, [install uv first](./install/uv.md). The `pipx` alternative does not require uv. + ```bash # Install from a specific stable release (recommended — replace vX.Y.Z with the latest tag) uvx --from git+https://github.com/github/spec-kit.git@vX.Y.Z specify init diff --git a/docs/toc.yml b/docs/toc.yml index 636a8f03a1..4101ae742d 100644 --- a/docs/toc.yml +++ b/docs/toc.yml @@ -11,6 +11,8 @@ href: quickstart.md - name: Upgrade href: upgrade.md + - name: Install uv + href: install/uv.md # Reference - name: Reference