From 497b5885e18e05d4ef7e628ea12d330e4b519980 Mon Sep 17 00:00:00 2001 From: Manfred Riem <15701806+mnriem@users.noreply.github.com> Date: Wed, 18 Mar 2026 14:21:20 -0500 Subject: [PATCH] docs: Add Extensions & Presets section to README (#1898) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * docs: add Extensions & Presets section to README Add a new 'Making Spec Kit Your Own: Extensions & Presets' section that covers: - Layering diagram (Mermaid) showing resolution order - Extensions: what they are, when to use, examples - Presets: what they are, when to use, examples - When-to-use-which comparison table - Links to extensions/README.md and presets/README.md * docs: clarify project-local overrides in layering diagram Address review feedback: explain the project-local overrides layer shown in the diagram, and adjust the intro to acknowledge it as a third customization mechanism alongside extensions and presets. * docs: Clarify template vs command resolution in README - Separate template resolution (top-down, first-match-wins stack) from command registration (written directly into agent directories) - Update Mermaid diagram paths to use and placeholders consistent with existing documentation Addresses PR review feedback on #1898. * docs: Clarify install-time vs runtime resolution for commands and templates - README: label templates as runtime-resolved (stack walk) and commands as install-time (copied into agent directories, last-installed wins) - presets/README: add runtime note to template resolution, contrast with install-time command registration * docs: Address review ā€” fix template copy wording, tighten command override description - presets/README: clarify that preset files are copied at install but template resolution still walks the stack at runtime - README: describe priority-based command resolution and automatic restoration on removal instead of vague 'replacing whatever was there' --- README.md | 63 +++++++++++++++++++++++++++++++++++++++++++++++ presets/README.md | 4 ++- 2 files changed, 66 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c958002b..c70de1ba 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,7 @@ - [šŸš¶ Community Walkthroughs](#-community-walkthroughs) - [šŸ¤– Supported AI Agents](#-supported-ai-agents) - [šŸ”§ Specify CLI Reference](#-specify-cli-reference) +- [šŸ§© Making Spec Kit Your Own: Extensions & Presets](#-making-spec-kit-your-own-extensions--presets) - [šŸ“š Core Philosophy](#-core-philosophy) - [šŸŒŸ Development Phases](#-development-phases) - [šŸŽÆ Experimental Goals](#-experimental-goals) @@ -326,6 +327,68 @@ Additional commands for enhanced quality and validation: | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `SPECIFY_FEATURE` | Override feature detection for non-Git repositories. Set to the feature directory name (e.g., `001-photo-albums`) to work on a specific feature when not using Git branches.
\*\*Must be set in the context of the agent you're working with prior to using `/speckit.plan` or follow-up commands. | +## šŸ§© Making Spec Kit Your Own: Extensions & Presets + +Spec Kit can be tailored to your needs through two complementary systems ā€” **extensions** and **presets** ā€” plus project-local overrides for one-off adjustments: + +```mermaid +block-beta + columns 1 + overrides["ā¬† Highest priority\nProject-Local Overrides\n.specify/templates/overrides/"] + presets["Presets ā€” Customize core & extensions\n.specify/presets//templates/"] + extensions["Extensions ā€” Add new capabilities\n.specify/extensions//templates/"] + core["Spec Kit Core ā€” Built-in SDD commands & templates\n.specify/templates/\nā¬‡ Lowest priority"] + + style overrides fill:transparent,stroke:#999 + style presets fill:transparent,stroke:#4a9eda + style extensions fill:transparent,stroke:#4a9e4a + style core fill:transparent,stroke:#e6a817 +``` + +**Templates** are resolved at **runtime** ā€” Spec Kit walks the stack top-down and uses the first match. Project-local overrides (`.specify/templates/overrides/`) let you make one-off adjustments for a single project without creating a full preset. **Commands** are applied at **install time** ā€” when you run `specify extension add` or `specify preset add`, command files are written into agent directories (e.g., `.claude/commands/`). If multiple presets or extensions provide the same command, the highest-priority version wins. On removal, the next-highest-priority version is restored automatically. If no overrides or customizations exist, Spec Kit uses its core defaults. + +### Extensions ā€” Add New Capabilities + +Use **extensions** when you need functionality that goes beyond Spec Kit's core. Extensions introduce new commands and templates ā€” for example, adding domain-specific workflows that are not covered by the built-in SDD commands, integrating with external tools, or adding entirely new development phases. They expand *what Spec Kit can do*. + +```bash +# Search available extensions +specify extension search + +# Install an extension +specify extension add +``` + +For example, extensions could add Jira integration, post-implementation code review, V-Model test traceability, or project health diagnostics. + +See the [Extensions README](./extensions/README.md) for the full guide, the complete community catalog, and how to build and publish your own. + +### Presets ā€” Customize Existing Workflows + +Use **presets** when you want to change *how* Spec Kit works without adding new capabilities. Presets override the templates and commands that ship with the core *and* with installed extensions ā€” for example, enforcing a compliance-oriented spec format, using domain-specific terminology, or applying organizational standards to plans and tasks. They customize the artifacts and instructions that Spec Kit and its extensions produce. + +```bash +# Search available presets +specify preset search + +# Install a preset +specify preset add +``` + +For example, presets could restructure spec templates to require regulatory traceability, adapt the workflow to fit the methodology you use (e.g., Agile, Kanban, Waterfall, jobs-to-be-done, or domain-driven design), add mandatory security review gates to plans, enforce test-first task ordering, or localize the entire workflow to a different language. The [pirate-speak demo](https://github.com/mnriem/spec-kit-pirate-speak-preset-demo) shows just how deep the customization can go. Multiple presets can be stacked with priority ordering. + +See the [Presets README](./presets/README.md) for the full guide, including resolution order, priority, and how to create your own. + +### When to Use Which + +| Goal | Use | +| --- | --- | +| Add a brand-new command or workflow | Extension | +| Customize the format of specs, plans, or tasks | Preset | +| Integrate an external tool or service | Extension | +| Enforce organizational or regulatory standards | Preset | +| Ship reusable domain-specific templates | Either ā€” presets for template overrides, extensions for templates bundled with new commands | + ## šŸ“š Core Philosophy Spec-Driven Development is a structured process that emphasizes: diff --git a/presets/README.md b/presets/README.md index 2fb22a71..f039b83d 100644 --- a/presets/README.md +++ b/presets/README.md @@ -13,13 +13,15 @@ When Spec Kit needs a template (e.g. `spec-template`), it walks a resolution sta If no preset is installed, core templates are used ā€” exactly the same behavior as before presets existed. +Template resolution happens **at runtime** ā€” although preset files are copied into `.specify/presets//` during installation, Spec Kit walks the resolution stack on every template lookup rather than merging templates into a single location. + For detailed resolution and command registration flows, see [ARCHITECTURE.md](ARCHITECTURE.md). ## Command Overrides Presets can also override the commands that guide the SDD workflow. Templates define *what* gets produced (specs, plans, constitutions); commands define *how* the LLM produces them (the step-by-step instructions). -When a preset includes `type: "command"` entries, the commands are automatically registered into all detected agent directories (`.claude/commands/`, `.gemini/commands/`, etc.) in the correct format (Markdown or TOML with appropriate argument placeholders). When the preset is removed, the registered commands are cleaned up. +Unlike templates, command overrides are applied **at install time**. When a preset includes `type: "command"` entries, the commands are registered into all detected agent directories (`.claude/commands/`, `.gemini/commands/`, etc.) in the correct format (Markdown or TOML with appropriate argument placeholders). When the preset is removed, the registered commands are cleaned up. ## Quick Start