mirror of
https://github.com/github/spec-kit.git
synced 2026-07-04 04:45:43 +08:00
707e929c2a
- Shorten README.md install section to single uv command + link to installation guide for alternatives and troubleshooting - Add explicit 'Initialize a project' step to README Get Started - Remove duplicate Troubleshooting section from README - Reorder 'Make it your own' card on docs landing page so extensions and presets are explained before the stats - Update Community nav-card to link to new community overview - Create docs/community/overview.md landing page (aligned with reference/overview.md) - Create dedicated install sub-pages: pipx, one-time (uvx), air-gapped - Update docs/installation.md to lead with persistent uv install and link to sub-pages instead of duplicating content - Update docs/toc.yml with new pages - Remove stale EOF file
33 lines
1.3 KiB
Markdown
33 lines
1.3 KiB
Markdown
# One-time Usage (uvx)
|
|
|
|
If you want to try Spec Kit without installing it permanently, use `uvx` to run it directly. This downloads the tool into a temporary environment that is discarded after the command finishes.
|
|
|
|
> [!NOTE]
|
|
> The commands below require **[uv](https://docs.astral.sh/uv/)**. If you see `command not found: uvx`, [install uv first](uv.md).
|
|
|
|
## Run Specify CLI
|
|
|
|
```bash
|
|
# Create a new project (latest from main)
|
|
uvx --from git+https://github.com/github/spec-kit.git specify init <PROJECT_NAME>
|
|
|
|
# Or target a specific release (replace vX.Y.Z with a tag from Releases)
|
|
uvx --from git+https://github.com/github/spec-kit.git@vX.Y.Z specify init <PROJECT_NAME>
|
|
|
|
# Initialize in the current directory
|
|
uvx --from git+https://github.com/github/spec-kit.git specify init . --integration copilot
|
|
|
|
# Or use the --here flag
|
|
uvx --from git+https://github.com/github/spec-kit.git specify init --here --integration copilot
|
|
```
|
|
|
|
## When to use persistent installation instead
|
|
|
|
If you plan to use Spec Kit regularly, a persistent installation is recommended:
|
|
|
|
- Tool stays installed and available in PATH
|
|
- No re-download on every invocation
|
|
- Better tool management with `uv tool list`, `uv tool upgrade`, `uv tool uninstall`
|
|
|
|
See the main [Installation Guide](../installation.md) for persistent installation instructions.
|