Skip to content

Documentation assumes prior knowledge of uv and its origin #1062

@MrHinsh

Description

@MrHinsh

The installation instructions currently show only:

uv tool install specify-cli --from git+https://github.com/github/spec-kit.git

The documentation assumes that users already know this is a Python-based implementation and that uv is installed. This is a false assumption and significantly limits accessibility.

Since uv is a third-party tool developed by [Astral](https://github.com/astral-sh/uv), and this is not mentioned anywhere, it seems that you expect potential users to just magically know this information. Please update the documentation to:

Suggested Fix

Add a short clarification under “⚡ Get Started → 1. Install Specify CLI”, explaining what uv is and how to install it.
For example:

#### Prerequisite: Install uv

The following installation command uses **[uv](https://docs.astral.sh/uv/)** — a modern Python package and environment manager by Astral.  
`uv` is not included in any operating system and must be installed separately.

You can install it via:
<pre>```bash
# macOS / Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

# Windows (PowerShell)
irm https://astral.sh/uv/install.ps1 | iex
````</pre>

Ensure you have **Python 3.11+** installed before running `uv`.

Then, continue with the existing installation section:

uv tool install specify-cli --from git+https://github.com/github/spec-kit.git

Rationale

This small addition would:

  • Prevent confusion for non-Python developers.
  • Improve onboarding by clearly identifying the required tooling.
  • Acknowledge the dependency on Astral’s uv, giving proper attribution and context.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No fields configured for Task.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions