User Input
$ARGUMENTS
You MUST consider the user input before proceeding (if not empty).
Pre-Execution Checks
Check for extension hooks (before planning):
- Check if
.specify/extensions.yml exists in the project root.
- If it exists, read it and look for entries under the
hooks.before_plan key
- If the YAML cannot be parsed or is invalid, skip hook checking silently and continue normally
- Filter out hooks where
enabled is explicitly false. Treat hooks without an enabled field as enabled by default.
- For each remaining hook, do not attempt to interpret or evaluate hook
condition expressions:
- If the hook has no
condition field, or it is null/empty, treat the hook as executable
- If the hook defines a non-empty
condition, skip the hook and leave condition evaluation to the HookExecutor implementation
- When constructing slash commands from hook command names, replace dots (
.) with hyphens (-). For example, speckit.git.commit → /speckit-git-commit.
- For each executable hook, output the following based on its
optional flag:
- Optional hook (
optional: true):## Extension Hooks
**Optional Pre-Hook**: {extension}
Command: `/{command}`
Description: {description}
Prompt: {prompt}
To execute: `/{command}`
- Mandatory hook (
optional: false):## Extension Hooks
**Automatic Pre-Hook**: {extension}
Executing: `/{command}`
EXECUTE_COMMAND: {command}
Wait for the result of the hook command before proceeding to the Outline.
After emitting the block above you MUST actually invoke the hook and wait for it to finish before continuing. Run it the same way you would run the command yourself in this agent/session (the invocation may differ from the literal {command} id shown above, e.g. a skills-mode agent runs it as /skill:speckit-... or $speckit-...). Emitting the block alone does not run the hook.
- If no hooks are registered or
.specify/extensions.yml does not exist, skip silently
Outline
Setup: Run .specify/scripts/bash/setup-plan.sh --json from repo root and parse JSON for FEATURE_SPEC, IMPL_PLAN, SPECS_DIR, BRANCH. For single quotes in args like "I'm Groot", use escape syntax: e.g 'I'''m Groot' (or double-quote if possible: "I'm Groot").
Load context: Read FEATURE_SPEC and .specify/memory/constitution.md. Load IMPL_PLAN template (already copied).
Execute plan workflow: Follow the structure in IMPL_PLAN template to:
- Fill Technical Context (mark unknowns as "NEEDS CLARIFICATION")
- Fill Constitution Check section from constitution
- Evaluate gates (ERROR if violations unjustified)
- Phase 0: Generate research.md (resolve all NEEDS CLARIFICATION)
- Phase 1: Generate data-model.md, contracts/, quickstart.md
- Phase 1: Update agent context by running the agent script
- Re-evaluate Constitution Check post-design
Mandatory Post-Execution Hooks
You MUST complete this section before reporting completion to the user.
Check if .specify/extensions.yml exists in the project root.
- If it does not exist, or no hooks are registered under
hooks.after_plan, skip to the Completion Report.
- If it exists, read it and look for entries under the
hooks.after_plan key.
- If the YAML cannot be parsed or is invalid, skip hook checking silently and continue to the Completion Report.
- Filter out hooks where
enabled is explicitly false. Treat hooks without an enabled field as enabled by default.
- For each remaining hook, do not attempt to interpret or evaluate hook
condition expressions:
- If the hook has no
condition field, or it is null/empty, treat the hook as executable
- If the hook defines a non-empty
condition, skip the hook and leave condition evaluation to the HookExecutor implementation
- When constructing slash commands from hook command names, replace dots (
.) with hyphens (-). For example, speckit.git.commit → /speckit-git-commit.
- For each executable hook, output the following based on its
optional flag:
- Mandatory hook (
optional: false) — You MUST emit EXECUTE_COMMAND: for each mandatory hook:## Extension Hooks
**Automatic Hook**: {extension}
Executing: `/{command}`
EXECUTE_COMMAND: {command}
After emitting the block above you MUST actually invoke the hook and wait for it to finish before continuing. Run it the same way you would run the command yourself in this agent/session (the invocation may differ from the literal {command} id shown above, e.g. a skills-mode agent runs it as /skill:speckit-... or $speckit-...). Emitting the block alone does not run the hook.
- Optional hook (
optional: true):## Extension Hooks
**Optional Hook**: {extension}
Command: `/{command}`
Description: {description}
Prompt: {prompt}
To execute: `/{command}`
Completion Report
Command ends after Phase 2 planning. Report branch, IMPL_PLAN path, and generated artifacts.
Phases
Phase 0: Outline & Research
Extract unknowns from Technical Context above:
- For each NEEDS CLARIFICATION → research task
- For each dependency → best practices task
- For each integration → patterns task
Generate and dispatch research agents:
For each unknown in Technical Context:
Task: "Research {unknown} for {feature context}"
For each technology choice:
Task: "Find best practices for {tech} in {domain}"
Consolidate findings in research.md using format:
- Decision: [what was chosen]
- Rationale: [why chosen]
- Alternatives considered: [what else evaluated]
Output: research.md with all NEEDS CLARIFICATION resolved
Phase 1: Design & Contracts
Prerequisites: research.md complete
Extract entities from feature spec → data-model.md:
- Entity name, fields, relationships
- Validation rules from requirements
- State transitions if applicable
Define interface contracts (if project has external interfaces) → /contracts/:
- Identify what interfaces the project exposes to users or other systems
- Document the contract format appropriate for the project type
- Examples: public APIs for libraries, command schemas for CLI tools, endpoints for web services, grammars for parsers, UI contracts for applications
- Skip if project is purely internal (build scripts, one-off tools, etc.)
Create quickstart validation guide → quickstart.md:
- Document runnable validation scenarios that prove the feature works end-to-end
- Include prerequisites, setup commands, test/run commands, and expected outcomes
- Use links or references to contracts and data model details instead of duplicating them
- Do not include full implementation code, model/service/controller bodies, migrations, or complete test suites
- Keep this artifact as a validation/run guide; implementation details belong in
tasks.md and the implementation phase
Agent context update:
- Update the plan reference between the
<!-- SPECKIT START --> and <!-- SPECKIT END --> markers in CLAUDE.md to point to the plan file created in step 1 (the IMPL_PLAN path)
Output: data-model.md, /contracts/*, quickstart.md, updated agent context file
Key rules
- Use absolute paths for filesystem operations; use project-relative paths for references in documentation and agent context files
- ERROR on gate failures or unresolved clarifications
- When research.md/plan.md names a specific code location, cite the module and symbol (e.g.
some/module.py::SomeClass), never a line number — implementation shifts lines before the plan merges. See dev/guidelines/documentation.md
Done When
1---2name: speckit-plan-43description: "Execute the implementation planning workflow using the plan template to generate design artifacts."4argument-hint: "Optional guidance for the planning phase"5compatibility: "Requires spec-kit project structure with .specify/ directory"6metadata:7 author: "github-spec-kit"8 source: https://skillmd.com/skills/opsmill/speckit-plan-49 upstream: "templates/commands/plan.md"10user-invocable: true11disable-model-invocation: false12---131415## User Input1617```text18$ARGUMENTS19```2021You **MUST** consider the user input before proceeding (if not empty).2223## Pre-Execution Checks2425**Check for extension hooks (before planning)**:26- Check if `.specify/extensions.yml` exists in the project root.27- If it exists, read it and look for entries under the `hooks.before_plan` key28- If the YAML cannot be parsed or is invalid, skip hook checking silently and continue normally29- Filter out hooks where `enabled` is explicitly `false`. Treat hooks without an `enabled` field as enabled by default.30- For each remaining hook, do **not** attempt to interpret or evaluate hook `condition` expressions:31 - If the hook has no `condition` field, or it is null/empty, treat the hook as executable32 - If the hook defines a non-empty `condition`, skip the hook and leave condition evaluation to the HookExecutor implementation33- When constructing slash commands from hook command names, replace dots (`.`) with hyphens (`-`). For example, `speckit.git.commit` → `/speckit-git-commit`.34- For each executable hook, output the following based on its `optional` flag:35 - **Optional hook** (`optional: true`):36 ```37 ## Extension Hooks3839 **Optional Pre-Hook**: {extension}40 Command: `/{command}`41 Description: {description}4243 Prompt: {prompt}44 To execute: `/{command}`45 ```46 - **Mandatory hook** (`optional: false`):47 ```48 ## Extension Hooks4950 **Automatic Pre-Hook**: {extension}51 Executing: `/{command}`52 EXECUTE_COMMAND: {command}5354 Wait for the result of the hook command before proceeding to the Outline.55 ```56 After emitting the block above you MUST actually invoke the hook and wait for it to finish before continuing. Run it the same way you would run the command yourself in this agent/session (the invocation may differ from the literal `{command}` id shown above, e.g. a skills-mode agent runs it as `/skill:speckit-...` or `$speckit-...`). Emitting the block alone does not run the hook.57- If no hooks are registered or `.specify/extensions.yml` does not exist, skip silently5859## Outline60611. **Setup**: Run `.specify/scripts/bash/setup-plan.sh --json` from repo root and parse JSON for FEATURE_SPEC, IMPL_PLAN, SPECS_DIR, BRANCH. For single quotes in args like "I'm Groot", use escape syntax: e.g 'I'''m Groot' (or double-quote if possible: "I'm Groot").62632. **Load context**: Read FEATURE_SPEC and `.specify/memory/constitution.md`. Load IMPL_PLAN template (already copied).64653. **Execute plan workflow**: Follow the structure in IMPL_PLAN template to:66 - Fill Technical Context (mark unknowns as "NEEDS CLARIFICATION")67 - Fill Constitution Check section from constitution68 - Evaluate gates (ERROR if violations unjustified)69 - Phase 0: Generate research.md (resolve all NEEDS CLARIFICATION)70 - Phase 1: Generate data-model.md, contracts/, quickstart.md71 - Phase 1: Update agent context by running the agent script72 - Re-evaluate Constitution Check post-design7374## Mandatory Post-Execution Hooks7576**You MUST complete this section before reporting completion to the user.**7778Check if `.specify/extensions.yml` exists in the project root.79- If it does not exist, or no hooks are registered under `hooks.after_plan`, skip to the Completion Report.80- If it exists, read it and look for entries under the `hooks.after_plan` key.81- If the YAML cannot be parsed or is invalid, skip hook checking silently and continue to the Completion Report.82- Filter out hooks where `enabled` is explicitly `false`. Treat hooks without an `enabled` field as enabled by default.83- For each remaining hook, do **not** attempt to interpret or evaluate hook `condition` expressions:84 - If the hook has no `condition` field, or it is null/empty, treat the hook as executable85 - If the hook defines a non-empty `condition`, skip the hook and leave condition evaluation to the HookExecutor implementation86- When constructing slash commands from hook command names, replace dots (`.`) with hyphens (`-`). For example, `speckit.git.commit` → `/speckit-git-commit`.87- For each executable hook, output the following based on its `optional` flag:88 - **Mandatory hook** (`optional: false`) — **You MUST emit `EXECUTE_COMMAND:` for each mandatory hook**:89 ```90 ## Extension Hooks9192 **Automatic Hook**: {extension}93 Executing: `/{command}`94 EXECUTE_COMMAND: {command}95 ```96 After emitting the block above you MUST actually invoke the hook and wait for it to finish before continuing. Run it the same way you would run the command yourself in this agent/session (the invocation may differ from the literal `{command}` id shown above, e.g. a skills-mode agent runs it as `/skill:speckit-...` or `$speckit-...`). Emitting the block alone does not run the hook.97 - **Optional hook** (`optional: true`):98 ```99 ## Extension Hooks100101 **Optional Hook**: {extension}102 Command: `/{command}`103 Description: {description}104105 Prompt: {prompt}106 To execute: `/{command}`107 ```108109## Completion Report110111Command ends after Phase 2 planning. Report branch, IMPL_PLAN path, and generated artifacts.112113## Phases114115### Phase 0: Outline & Research1161171. **Extract unknowns from Technical Context** above:118 - For each NEEDS CLARIFICATION → research task119 - For each dependency → best practices task120 - For each integration → patterns task1211222. **Generate and dispatch research agents**:123124 ```text125 For each unknown in Technical Context:126 Task: "Research {unknown} for {feature context}"127 For each technology choice:128 Task: "Find best practices for {tech} in {domain}"129 ```1301313. **Consolidate findings** in `research.md` using format:132 - Decision: [what was chosen]133 - Rationale: [why chosen]134 - Alternatives considered: [what else evaluated]135136**Output**: research.md with all NEEDS CLARIFICATION resolved137138### Phase 1: Design & Contracts139140**Prerequisites:** `research.md` complete1411421. **Extract entities from feature spec** → `data-model.md`:143 - Entity name, fields, relationships144 - Validation rules from requirements145 - State transitions if applicable1461472. **Define interface contracts** (if project has external interfaces) → `/contracts/`:148 - Identify what interfaces the project exposes to users or other systems149 - Document the contract format appropriate for the project type150 - Examples: public APIs for libraries, command schemas for CLI tools, endpoints for web services, grammars for parsers, UI contracts for applications151 - Skip if project is purely internal (build scripts, one-off tools, etc.)1521533. **Create quickstart validation guide** → `quickstart.md`:154 - Document runnable validation scenarios that prove the feature works end-to-end155 - Include prerequisites, setup commands, test/run commands, and expected outcomes156 - Use links or references to contracts and data model details instead of duplicating them157 - Do not include full implementation code, model/service/controller bodies, migrations, or complete test suites158 - Keep this artifact as a validation/run guide; implementation details belong in `tasks.md` and the implementation phase1591604. **Agent context update**:161 - Update the plan reference between the `<!-- SPECKIT START -->` and `<!-- SPECKIT END -->` markers in `CLAUDE.md` to point to the plan file created in step 1 (the IMPL_PLAN path)162163**Output**: data-model.md, /contracts/*, quickstart.md, updated agent context file164165## Key rules166167- Use absolute paths for filesystem operations; use project-relative paths for references in documentation and agent context files168- ERROR on gate failures or unresolved clarifications169- When research.md/plan.md names a specific code location, cite the module and symbol (e.g. `some/module.py::SomeClass`), never a line number — implementation shifts lines before the plan merges. See `dev/guidelines/documentation.md`170171## Done When172173- [ ] Plan workflow executed and design artifacts generated174- [ ] Extension hooks dispatched or skipped according to the rules in Mandatory Post-Execution Hooks above175- [ ] Completion reported to user with branch, plan path, and generated artifacts