Spec Kit

https://github.github.io/spec-kit/
Admin
Spec Kit is a framework and guide for Spec-Driven Development, a methodology that enables...
Tokens:138,633
Snippets:1,460
Trust Score:9.7
Update:3 hours ago
Show doc for...
Tokens:
Raw
### Install example overlay

Source: https://github.github.io/spec-kit/reference/workflows.html

Installs the example overlay project-overlay.yml with priority 10.

```bash
specify workflow overlay add project-overlay.yml --priority 10

```

--------------------------------

### specify init usage examples

Source: https://github.github.io/spec-kit/reference/core.html

Examples of initializing a project with different options: creating a new project with an integration, initializing in the current directory, force merging into a non-empty directory, using PowerShell scripts, and installing a preset during initialization.

```bash
# Create a new project with an integration
specify init my-project --integration copilot

# Initialize in the current directory
specify init --here --integration copilot

# Force merge into a non-empty directory
specify init --here --force --integration copilot

# Use PowerShell scripts (Windows/cross-platform)
specify init my-project --integration copilot --script ps

# Install a preset during initialization
specify init my-project --integration copilot --preset compliance
```

--------------------------------

### Example .specify/preset-catalogs.yml

Source: https://github.github.io/spec-kit/reference/presets.html

Example project configuration file that adds a catalog with a name, URL, priority, install permission, and description. This file controls where `add` and `search` look for presets.

```yaml
catalogs:
  - name: "my-org-presets"
    url: "https://example.com/preset-catalog.json"
    priority: 5
    install_allowed: true
    description: "Our approved presets"
```

--------------------------------

### .specify/extensions.yml configuration example

Source: https://github.github.io/spec-kit/reference/extensions.html

Example configuration file showing installed extensions, global settings, and hook registrations for before_implement and after_implement events. Note that auto_execute_hooks defaults to true but is currently reserved and not consulted.

```yaml
installed:
  - git
  - my-extension

settings:
  auto_execute_hooks: true

hooks:
  before_implement:
    - extension: git
      command: speckit.git.commit
      enabled: true
      optional: true
      priority: 10
      prompt: "Commit outstanding changes before implementation?"
      description: "Auto-commit before implementation"

  after_implement:
    - extension: my-extension
      command: speckit.my-extension.verify
      enabled: true
      optional: false
      priority: 5
      description: "Run verification after implementation"
```

--------------------------------

### Install an integration with specify integration install

Source: https://github.github.io/spec-kit/integrations/cli.html

Installs the integration into the current project. Multi-install proceeds automatically only when all involved integrations are declared safe; otherwise use `switch` to replace the default or `--force` to opt in. Failed setup triggers rollback. Catalog history is metadata only; there is no `integration install --version`.

```bash
specify integration install <key>
```

--------------------------------

### Example .specify/extension-catalogs.yml

Source: https://github.github.io/spec-kit/reference/extensions.html

Example configuration for a catalog you own and vet, with install_allowed: true.

```yaml
catalogs:
  - name: "my-org-catalog"
    url: "https://example.com/catalog.json"
    priority: 5
    install_allowed: true
    description: "Our approved extensions"
```

--------------------------------

### Bundle management commands

Source: https://github.github.io/spec-kit/guides/customization.html

Search, inspect, and install bundles for role-based setups. Inspect info before installing to see the resolved component set.

```bash
specify bundle search
specify bundle info <bundle-id>
specify bundle install <bundle-id>
```

--------------------------------

### Install a vetted extension from a discovery-only catalog

Source: https://github.github.io/spec-kit/reference/extensions.html

Use 'specify extension info' to get the candidate archive URL, then install with '--from'. Treat the URL as untrusted until vetted.

```bash
specify extension info <name>          # shows the candidate archive URL
specify extension add <name> --from <archive-url>
```

--------------------------------

### Register catalog and install external adapter

Source: https://github.github.io/spec-kit/integrations/cli.html

Registers a reviewed catalog in the initialized project, then installs and activates its adapter. Installation prompts for trust before downloading/importing Python.

```bash
specify integration catalog add https://example.com/catalog.json --name samples
specify integration install sample-agent
specify integration use sample-agent
```

--------------------------------

### Initialize project with IBM Bob integration

Source: https://github.github.io/spec-kit/integrations/bob.html

Run this command to scaffold a new Spec Kit project with the IBM Bob integration. Requires IBM Bob to be installed beforehand; the integration key is 'bob' and no separate CLI is needed for IDE setup.

```bash
specify init my-project --integration bob
```

--------------------------------

### Install first-party bundles with specify bundle install and add

Source: https://github.github.io/spec-kit/reference/bundles.html

Install a first-party bundle using the specify CLI. The add command is an alias for install. The first-party catalog is fetched online and falls back to the packaged wheel snapshot offline.

```bash
specify bundle install bugfix
specify bundle add assess
```

--------------------------------

### Install step from catalog

Source: https://github.github.io/spec-kit/reference/workflows.html

Installs a step from the active step catalogs. Catalog installs resolve individual file URLs and go through the same validation and commit path as --dev and --from. Discovery-only catalogs cannot be installed from.

```bash
specify workflow step add my-step
```

--------------------------------

### Install uv on Windows with the standalone installer

Source: https://github.github.io/spec-kit/install/uv.html

Run this PowerShell command in Command Prompt or PowerShell to install uv. After it finishes, open a new terminal so the uv binary is on your PATH.

```powershell
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
```

--------------------------------

### Install uv on Windows with WinGet

Source: https://github.github.io/spec-kit/install/uv.html

Use WinGet to install uv on Windows.

```powershell
winget install --id=astral-sh.uv -e
```

--------------------------------

### Install an Extension

Source: https://github.github.io/spec-kit/reference/extensions.html

Installs an extension from the catalog, a URL, or a local directory. Options include `--dev`, `--from <url>`, `--version <v>`, `--force`, and `--priority <N>` (default: 10; lower = higher precedence). Requires a project initialized with `specify init`.

```bash
specify extension add <name>
```

--------------------------------

### Install a preset with specify preset add

Source: https://github.github.io/spec-kit/reference/presets.html

Installs a preset from the catalog, a URL, or a local directory. The `--version` option selects an exact release and cannot be combined with `--from` or `--dev`. Requires a project initialized with `specify init`.

```bash
specify preset add [<preset_id>]
specify preset add <preset_id> --version <version>
```

--------------------------------

### Initialize a project with specify init

Source: https://github.github.io/spec-kit/installation.html

After installing, initialize a project with the Copilot integration. Replace <PROJECT_NAME> with your project name.

```bash
specify init <PROJECT_NAME> --integration copilot
```

--------------------------------

### List Available Integrations

Source: https://github.github.io/spec-kit/integrations/cli.html

Lists built-in and trusted installed external integrations, their setup requirements, and multi-install safety declarations. Use `--catalog` to also browse the catalog, including external integrations not installed in this project.

```bash
specify integration list
```

--------------------------------

### Initialize project with Qwen integration

Source: https://github.github.io/spec-kit/integrations/qwen.html

Run this command to create a new Spec Kit project with the Qwen Code integration. The integration key is 'qwen'.

```bash
specify init my-project --integration qwen
```

--------------------------------

### Initialize Spec Kit project with Firebender integration

Source: https://github.github.io/spec-kit/integrations/firebender.html

Run this command to create a new Spec Kit project with the Firebender integration. Requires Firebender to be installed in Android Studio or IntelliJ before setup.

```bash
specify init my-project --integration firebender
```

--------------------------------

### Set up isolated environment with editable install

Source: https://github.github.io/spec-kit/local-development.html

Creates a virtual environment with `uv`, activates it, installs the project in editable mode, and verifies the `specify` entrypoint. Editable mode means no reinstall is needed after code edits.

```bash
# Create & activate virtual env (uv auto-manages .venv)
uv venv
source .venv/bin/activate  # or on Windows PowerShell: .venv\Scripts\Activate.ps1

# Install project in editable mode
uv pip install -e .

# Now 'specify' entrypoint is available
specify --help
```

--------------------------------

### Initialize project with SHAI integration

Source: https://github.github.io/spec-kit/integrations/shai.html

Run this command to create a new Spec Kit project with the SHAI integration enabled. Requires SHAI to be installed beforehand.

```bash
specify init my-project --integration shai
```

--------------------------------

### Upgrade CLI and update integrations for new slash commands

Source: https://github.github.io/spec-kit/upgrade.html

Use this sequence to upgrade the Spec Kit CLI and refresh project files to get new slash commands. The CLI auto-detects whether it was installed via uv tool or pipx.

```bash
# Upgrade CLI (auto-detects uv tool vs pipx install)
specify self upgrade

# Inspect installed integrations
specify integration status

# Update project files to get new commands
specify integration upgrade <key>
specify extension update
```

--------------------------------

### Run CLI directly via module entrypoint

Source: https://github.github.io/spec-kit/local-development.html

Executes the CLI without installation using `python -m src.specify_cli`. The example shows the `--help` flag and an `init` command with options `--integration claude`, `--ignore-agent-tools`, and `--script sh`.

```bash
# From repo root
python -m src.specify_cli --help
python -m src.specify_cli init demo-project --integration claude --ignore-agent-tools --script sh
```

--------------------------------

### Initialize Spec Kit in Non-Empty Directory with Force

Source: https://github.github.io/spec-kit/installation.html

Use this command when initializing in a non-empty directory. The `--force` flag acknowledges the merge warning. Review the existing-project guide and commit or back up local changes before initializing. This example selects the Claude integration explicitly.

```bash
specify init --here --force --non-interactive --integration claude
```

--------------------------------

### Configure runtime events in .specify/integration-events.yml

Source: https://github.github.io/spec-kit/integrations/cli.html

Create .specify/integration-events.yml to override event handlers for an integration. Replace <key> with your integration key and the example command with an installed, script-backed Spec Kit command. A valid override replaces the entire event map for that integration; set events: {} to disable all handlers.

```yaml
integrations:
  <key>:
    events:
      post_tool_use:
        - command: speckit.my-extension.check
          matcher: "*"
          timeout: 60

```

--------------------------------

### Add required catalogs and install a community bundle

Source: https://github.github.io/spec-kit/community/bundles.html

Shows how to add preset and extension catalogs with --install-allowed, download the bundle artifact, and install it. Also shows installing by ID from an install-allowed bundle catalog. Use this when your bundle depends on components not in the default Spec Kit catalogs.

```bash
specify preset catalog add https://example.com/presets.json --name example-bundle --install-allowed
specify extension catalog add https://example.com/extensions.json --name example-bundle --install-allowed
curl -L -o example-bundle-1.0.0.zip https://example.com/example-bundle-1.0.0.zip
specify bundle install ./example-bundle-1.0.0.zip

# Or install by id from an install-allowed bundle catalog.
specify bundle catalog add https://example.com/bundles.json --id example-bundle-catalog --policy install-allowed
specify bundle install example-bundle
```

--------------------------------

### Disable Spec Kit event handlers during upgrade

Source: https://github.github.io/spec-kit/integrations/cli.html

Use this CLI command to disable Spec Kit event handlers for an event-capable integration during an upgrade. Supplying --integration-options replaces stored setup options, so repeat other options you want to keep. A disabled event set removes previously installed Spec Kit hooks.

```bash
specify integration upgrade <key> --integration-options="--events false"

```

--------------------------------

### Initialize project with Alquimia integration

Source: https://github.github.io/spec-kit/integrations/alquimia.html

Run this command to create a new Spec Kit project with the Alquimia AI integration enabled. The integration key is 'alquimia'.

```bash
specify init my-project --integration alquimia
```

--------------------------------

### Install specify-cli from PyPI

Source: https://github.github.io/spec-kit/installation.html

Install the published specify-cli package using uv, pipx, or pip. If already installed, these commands keep the installed version; use --force or --upgrade to replace.

```bash
# Using uv (recommended)
uv tool install specify-cli

# Or using pipx
pipx install specify-cli

# Or using pip
pip install specify-cli
```

--------------------------------

### Initialize a Project with a Bundle using specify bundle init

Source: https://github.github.io/spec-kit/reference/bundles.html

Ensures the current directory is a Spec Kit project (initializing idempotently if needed) and optionally installs the given bundle. Repeating skips already installed components and preserves local edits. Fails without changes if the manifest changes the recorded bundle version, owned component version, source, preset priority, or strategy, or removes an owned component. Use `bundle update <id>` for catalog bundles or `bundle install <path> --refresh` for local sources to refresh.

```bash
specify bundle init [<bundle_id>]
```

--------------------------------

### Initialize project with Qoder CLI integration

Source: https://github.github.io/spec-kit/integrations/qodercli.html

Run this command to create a new Spec Kit project with the Qoder CLI integration. The integration key is 'qodercli'.

```bash
specify init my-project --integration qodercli
```

--------------------------------

### Upgrade an installed integration with specify integration upgrade

Source: https://github.github.io/spec-kit/upgrade.html

Run inside the project directory, replacing <key> with an installed integration key such as copilot, claude, or codex. In projects with multiple installed integrations, run once per installed key.

```bash
specify integration upgrade <key>
```

--------------------------------

### Setup commands for auth.json

Source: https://github.github.io/spec-kit/reference/authentication.html

Commands to create the ~/.specify directory, copy the JSON above into ~/.specify/auth.json, and set file permissions to 600.

```bash
mkdir -p ~/.specify
# Copy the JSON above into ~/.specify/auth.json
chmod 600 ~/.specify/auth.json
```

--------------------------------

### Initialize project with external adapter

Source: https://github.github.io/spec-kit/integrations/cli.html

Supplies an external adapter during initialization using a project/user catalog or `SPECKIT_INTEGRATION_CATALOG_URL`. Review the external adapter API before publishing a package.

```bash
specify init my-project --integration sample-agent --trust-integration
```

--------------------------------

### List installed workflows

Source: https://github.github.io/spec-kit/reference/workflows.html

Lists workflows installed in the current project.

```bash
specify workflow list
```

--------------------------------

### Initialize a new project with Tabnine integration

Source: https://github.github.io/spec-kit/integrations/tabnine.html

Run this command to create a new Spec Kit project with the Tabnine integration. The integration key is 'tabnine'.

```bash
specify init my-project --integration tabnine
```

--------------------------------

### Initialize project with DeepSeek Harness integration

Source: https://github.github.io/spec-kit/integrations/dsh.html

Run this command to create a new Spec Kit project with the DeepSeek Harness integration installed. Requires DeepSeek Harness to be installed beforehand.

```bash
specify init my-project --integration dsh
```

--------------------------------

### Example integration-catalogs.yml

Source: https://github.github.io/spec-kit/integrations/catalog.html

Example configuration file for specifying integration catalogs. The first configured layer replaces lower layers, and within a layer, lower numeric priority wins. Adding the first project catalog replaces default sources unless they are also listed.

```yaml
catalogs:
  - url: "https://example.com/my-catalog.json"
    name: "my-catalog"
    priority: 1
    install_allowed: true
```

--------------------------------

### Install Git Credential Manager on Linux

Source: https://github.github.io/spec-kit/install/air-gapped.html

Downloads and installs Git Credential Manager v2.6.1, configures Git to use it, and cleans up the installer. Useful for Git authentication issues on Linux.

```bash
#!/usr/bin/env bash
set -e
echo "Downloading Git Credential Manager v2.6.1..."
wget https://github.com/git-ecosystem/git-credential-manager/releases/download/v2.6.1/gcm-linux_amd64.2.6.1.deb
echo "Installing Git Credential Manager..."
sudo dpkg -i gcm-linux_amd64.2.6.1.deb
echo "Configuring Git to use GCM..."
git config --global credential.helper manager
echo "Cleaning up..."
rm gcm-linux_amd64.2.6.1.deb
```

--------------------------------

### Initialize a new project with the Amp integration

Source: https://github.github.io/spec-kit/integrations/amp.html

Run this command to create a new Spec Kit project with the Amp integration. The integration key is 'amp' and the Amp CLI must be installed beforehand.

```bash
specify init my-project --integration amp
```

--------------------------------

### Install uv on Windows with Scoop

Source: https://github.github.io/spec-kit/install/uv.html

Use Scoop to install uv on Windows.

```powershell
scoop install uv
```

--------------------------------

### Initialize a new project with the Kimi integration

Source: https://github.github.io/spec-kit/integrations/kimi.html

Use this command to create a new Spec Kit project with the Kimi Code integration. The integration key is 'kimi'.

```bash
specify init my-project --integration kimi
```

--------------------------------

### Install and initialize Spec Kit CLI

Source: https://github.github.io/spec-kit/quickstart.html

Install the specify-cli from PyPI using uv, then initialize a project with the copilot integration and change into the project directory. Add --non-interactive for CI or agent harnesses to avoid interactive prompts.

```bash
uv tool install specify-cli
specify init taskify --integration copilot
cd taskify
```
Tokens:
Raw