From f7fa7ce7576c402e9a51c2ce08e57990c3012a01 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 6 May 2026 12:54:29 +0000 Subject: [PATCH 1/5] Initial plan From 2e804a712b5ddb066962b7f433f3435fcbf1394f Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 6 May 2026 12:59:11 +0000 Subject: [PATCH 2/5] docs: Add uv installation guide and inline callouts Agent-Logs-Url: https://github.com/github/spec-kit/sessions/027c81a0-57f2-4f67-ab54-4c72f93eb254 Co-authored-by: mnriem <15701806+mnriem@users.noreply.github.com> --- README.md | 3 +++ docs/install/uv.md | 60 ++++++++++++++++++++++++++++++++++++++++++++ docs/installation.md | 3 +++ docs/toc.yml | 2 ++ 4 files changed, 68 insertions(+) create mode 100644 docs/install/uv.md diff --git a/README.md b/README.md index 2ccc5d3fc0..448612c92b 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 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). + ```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..5c1e0db131 --- /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, open a new terminal (or run `source $HOME/.local/bin/env`) so the `uv` binary is on your `PATH`. + +### Windows — Standalone Installer + +On Windows, run the following in 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..b7eb005ce5 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 commands below require **[uv](https://docs.astral.sh/uv/)**. If you see `command not found: uv` or `command not found: uvx`, [install uv first](./install/uv.md). + ```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 From 7c1938523cc7496db86812bd5f4e0858cb572221 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 6 May 2026 19:18:38 +0000 Subject: [PATCH 3/5] docs: improve uv install guide PATH and Windows instructions Agent-Logs-Url: https://github.com/github/spec-kit/sessions/f56bcfb8-2cf5-44a5-b5e5-0fd6c3caa46f Co-authored-by: mnriem <15701806+mnriem@users.noreply.github.com> --- docs/install/uv.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/install/uv.md b/docs/install/uv.md index 5c1e0db131..21e6d23baf 100644 --- a/docs/install/uv.md +++ b/docs/install/uv.md @@ -15,11 +15,11 @@ The quickest way to install uv on macOS or Linux is the official shell script: curl -LsSf https://astral.sh/uv/install.sh | sh ``` -After the script finishes, open a new terminal (or run `source $HOME/.local/bin/env`) so the `uv` binary is on your `PATH`. +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 -On Windows, run the following in PowerShell: +Run the following in **Command Prompt or PowerShell**: ```powershell powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex" From 3cca2f5904c18acbbe74c91e710725b50ad6e693 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 6 May 2026 19:33:05 +0000 Subject: [PATCH 4/5] docs: clarify uv note in README applies only to uv commands not pipx Agent-Logs-Url: https://github.com/github/spec-kit/sessions/a6ada1f7-522d-4a31-ac5b-880e763f9c97 Co-authored-by: mnriem <15701806+mnriem@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 448612c92b..0ebd129557 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,7 @@ 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 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 `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) From 1922ff9b44d852412e415d285f68a1920b003842 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 6 May 2026 19:41:50 +0000 Subject: [PATCH 5/5] docs: clarify uv note in installation.md applies only to uvx commands not pipx Agent-Logs-Url: https://github.com/github/spec-kit/sessions/4ec791dd-b048-4606-8db3-671bc8956b05 Co-authored-by: mnriem <15701806+mnriem@users.noreply.github.com> --- docs/installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installation.md b/docs/installation.md index b7eb005ce5..cafd6eb116 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -17,7 +17,7 @@ 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 commands below require **[uv](https://docs.astral.sh/uv/)**. If you see `command not found: uv` or `command not found: uvx`, [install uv first](./install/uv.md). +> 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)