docs/installation.md
[!IMPORTANT] The only official, maintained packages for Spec Kit come from the github/spec-kit GitHub repository. Any packages with the same name available on PyPI (e.g.
specify-clion pypi.org) are not affiliated with this project and are not maintained by the Spec Kit maintainers. For normal installs, use the GitHub-based commands shown below. For offline or air-gapped environments, locally built wheels created from this repository are also valid.
Install once and use everywhere. Replace vX.Y.Z with a tag from Releases:
[!NOTE] The command below requires uv. If you see
command not found: uv, install uv first.
uv tool install specify-cli --from git+https://github.com/github/[email protected]
Then initialize a project:
specify init <PROJECT_NAME> --integration copilot
Run directly without installing — see the One-time usage (uvx) guide.
Interactive terminals prompt you to choose a coding agent integration during initialization. Non-interactive sessions, such as CI or piped runs, default to GitHub Copilot unless you pass --integration.
You can proactively specify your coding agent integration during initialization:
specify init <project_name> --integration claude
specify init <project_name> --integration gemini
specify init <project_name> --integration copilot
specify init <project_name> --integration codebuddy
specify init <project_name> --integration pi
All automation scripts now have both Bash (.sh) and PowerShell (.ps1) variants.
Auto behavior:
pssh--scriptForce a specific script type:
specify init <project_name> --script sh
specify init <project_name> --script ps
If you prefer to get the templates without checking for the right tools:
specify init <project_name> --integration claude --ignore-agent-tools
After installation, run the following command to confirm the correct version is installed:
specify version
This helps verify you are running the official Spec Kit build from GitHub, not an unrelated package with the same name.
Stay current: Run specify self check periodically to learn whether a newer release is available — it is read-only and never modifies your installation. When you are ready to upgrade, follow the Upgrade Guide.
After initialization, you should see the following commands available in your coding agent:
/speckit.specify - Create specifications/speckit.plan - Generate implementation plans/speckit.tasks - Break down into actionable tasksScripts are installed into a variant subdirectory matching the chosen script type:
.specify/scripts/bash/ — contains .sh scripts (default on Linux/macOS).specify/scripts/powershell/ — contains .ps1 scripts (default on Windows)If your environment blocks access to PyPI or GitHub, see the Enterprise / Air-Gapped Installation guide for step-by-step instructions on creating portable wheel bundles.
If you're having issues with Git authentication on Linux, see the Air-Gapped Installation guide for Git Credential Manager setup instructions.