Skip to content

Commit 15e5572

Browse files
committed
Update command reference
1 parent cde400f commit 15e5572

File tree

14 files changed

+83
-83
lines changed

14 files changed

+83
-83
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Here are a few things you can do that will increase the likelihood of your pull
4040

4141
When working on spec-kit:
4242

43-
1. Test changes with the `specify` CLI commands (`/specify`, `/plan`, `/tasks`) in your coding agent of choice
43+
1. Test changes with the `specify` CLI commands (`/speckit.specify`, `/speckit.plan`, `/speckit.tasks`) in your coding agent of choice
4444
2. Verify templates are working correctly in `templates/` directory
4545
3. Test script functionality in the `scripts/` directory
4646
4. Ensure memory files (`memory/constitution.md`) are updated if major process changes are made

README.md

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -73,42 +73,42 @@ uvx --from git+https://github.com/github/spec-kit.git specify init <PROJECT_NAME
7373

7474
### 2. Establish project principles
7575

76-
Use the **`/constitution`** command to create your project's governing principles and development guidelines that will guide all subsequent development.
76+
Use the **`/speckit.constitution`** command to create your project's governing principles and development guidelines that will guide all subsequent development.
7777

7878
```bash
79-
/constitution Create principles focused on code quality, testing standards, user experience consistency, and performance requirements
79+
/speckit.constitution Create principles focused on code quality, testing standards, user experience consistency, and performance requirements
8080
```
8181

8282
### 3. Create the spec
8383

84-
Use the **`/specify`** command to describe what you want to build. Focus on the **what** and **why**, not the tech stack.
84+
Use the **`/speckit.specify`** command to describe what you want to build. Focus on the **what** and **why**, not the tech stack.
8585

8686
```bash
87-
/specify Build an application that can help me organize my photos in separate photo albums. Albums are grouped by date and can be re-organized by dragging and dropping on the main page. Albums are never in other nested albums. Within each album, photos are previewed in a tile-like interface.
87+
/speckit.specify Build an application that can help me organize my photos in separate photo albums. Albums are grouped by date and can be re-organized by dragging and dropping on the main page. Albums are never in other nested albums. Within each album, photos are previewed in a tile-like interface.
8888
```
8989

9090
### 4. Create a technical implementation plan
9191

92-
Use the **`/plan`** command to provide your tech stack and architecture choices.
92+
Use the **`/speckit.plan`** command to provide your tech stack and architecture choices.
9393

9494
```bash
95-
/plan The application uses Vite with minimal number of libraries. Use vanilla HTML, CSS, and JavaScript as much as possible. Images are not uploaded anywhere and metadata is stored in a local SQLite database.
95+
/speckit.plan The application uses Vite with minimal number of libraries. Use vanilla HTML, CSS, and JavaScript as much as possible. Images are not uploaded anywhere and metadata is stored in a local SQLite database.
9696
```
9797

9898
### 5. Break down into tasks
9999

100-
Use **`/tasks`** to create an actionable task list from your implementation plan.
100+
Use **`/speckit.tasks`** to create an actionable task list from your implementation plan.
101101

102102
```bash
103-
/tasks
103+
/speckit.tasks
104104
```
105105

106106
### 6. Execute implementation
107107

108-
Use **`/implement`** to execute all tasks and build your feature according to the plan.
108+
Use **`/speckit.implement`** to execute all tasks and build your feature according to the plan.
109109

110110
```bash
111-
/implement
111+
/speckit.implement
112112
```
113113

114114
For detailed step-by-step instructions, see our [comprehensive guide](./spec-driven.md).
@@ -211,29 +211,29 @@ After running `specify init`, your AI coding agent will have access to these sla
211211

212212
Essential commands for the Spec-Driven Development workflow:
213213

214-
| Command | Description |
215-
|-----------------|-----------------------------------------------------------------------|
216-
| `/constitution` | Create or update project governing principles and development guidelines |
217-
| `/specify` | Define what you want to build (requirements and user stories) |
218-
| `/plan` | Create technical implementation plans with your chosen tech stack |
219-
| `/tasks` | Generate actionable task lists for implementation |
220-
| `/implement` | Execute all tasks to build the feature according to the plan |
214+
| Command | Description |
215+
|--------------------------|-----------------------------------------------------------------------|
216+
| `/speckit.constitution` | Create or update project governing principles and development guidelines |
217+
| `/speckit.specify` | Define what you want to build (requirements and user stories) |
218+
| `/speckit.plan` | Create technical implementation plans with your chosen tech stack |
219+
| `/speckit.tasks` | Generate actionable task lists for implementation |
220+
| `/speckit.implement` | Execute all tasks to build the feature according to the plan |
221221

222222
#### Optional Commands
223223

224224
Additional commands for enhanced quality and validation:
225225

226-
| Command | Description |
227-
|-----------------|-----------------------------------------------------------------------|
228-
| `/clarify` | Clarify underspecified areas (recommended before `/plan`; formerly `/quizme`) |
229-
| `/analyze` | Cross-artifact consistency & coverage analysis (run after /tasks, before /implement) |
230-
| `/checklist` | Generate custom quality checklists that validate requirements completeness, clarity, and consistency (like "unit tests for English") |
226+
| Command | Description |
227+
|----------------------|-----------------------------------------------------------------------|
228+
| `/speckit.clarify` | Clarify underspecified areas (recommended before `/speckit.plan`; formerly `/quizme`) |
229+
| `/speckit.analyze` | Cross-artifact consistency & coverage analysis (run after `/speckit.tasks`, before `/speckit.implement`) |
230+
| `/speckit.checklist` | Generate custom quality checklists that validate requirements completeness, clarity, and consistency (like "unit tests for English") |
231231

232232
### Environment Variables
233233

234234
| Variable | Description |
235235
|------------------|------------------------------------------------------------------------------------------------|
236-
| `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.<br/>**Must be set in the context of the agent you're working with prior to using `/plan` or follow-up commands. |
236+
| `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.<br/>**Must be set in the context of the agent you're working with prior to using `/speckit.plan` or follow-up commands. |
237237

238238
## 📚 Core philosophy
239239

@@ -354,19 +354,19 @@ Go to the project folder and run your AI agent. In our example, we're using `cla
354354

355355
![Bootstrapping Claude Code environment](./media/bootstrap-claude-code.gif)
356356

357-
You will know that things are configured correctly if you see the `/constitution`, `/specify`, `/plan`, `/tasks`, and `/implement` commands available.
357+
You will know that things are configured correctly if you see the `/speckit.constitution`, `/speckit.specify`, `/speckit.plan`, `/speckit.tasks`, and `/speckit.implement` commands available.
358358

359-
The first step should be establishing your project's governing principles using the `/constitution` command. This helps ensure consistent decision-making throughout all subsequent development phases:
359+
The first step should be establishing your project's governing principles using the `/speckit.constitution` command. This helps ensure consistent decision-making throughout all subsequent development phases:
360360

361361
```text
362-
/constitution Create principles focused on code quality, testing standards, user experience consistency, and performance requirements. Include governance for how these principles should guide technical decisions and implementation choices.
362+
/speckit.constitution Create principles focused on code quality, testing standards, user experience consistency, and performance requirements. Include governance for how these principles should guide technical decisions and implementation choices.
363363
```
364364

365365
This step creates or updates the `.specify/memory/constitution.md` file with your project's foundational guidelines that the AI agent will reference during specification, planning, and implementation phases.
366366

367367
### **STEP 2:** Create project specifications
368368

369-
With your project principles established, you can now create the functional specifications. Use the `/specify` command and then provide the concrete requirements for the project you want to develop.
369+
With your project principles established, you can now create the functional specifications. Use the `/speckit.specify` command and then provide the concrete requirements for the project you want to develop.
370370

371371
>[!IMPORTANT]
372372
>Be as explicit as possible about _what_ you are trying to build and _why_. **Do not focus on the tech stack at this point**.
@@ -426,12 +426,12 @@ With the baseline specification created, you can go ahead and clarify any of the
426426
You should run the structured clarification workflow **before** creating a technical plan to reduce rework downstream.
427427

428428
Preferred order:
429-
1. Use `/clarify` (structured) – sequential, coverage-based questioning that records answers in a Clarifications section.
429+
1. Use `/speckit.clarify` (structured) – sequential, coverage-based questioning that records answers in a Clarifications section.
430430
2. Optionally follow up with ad-hoc free-form refinement if something still feels vague.
431431

432432
If you intentionally want to skip clarification (e.g., spike or exploratory prototype), explicitly state that so the agent doesn't block on missing clarifications.
433433

434-
Example free-form refinement prompt (after `/clarify` if still needed):
434+
Example free-form refinement prompt (after `/speckit.clarify` if still needed):
435435

436436
```text
437437
For each sample project or project that you create there should be a variable number of tasks between 5 and 15
@@ -449,7 +449,7 @@ It's important to use the interaction with Claude Code as an opportunity to clar
449449

450450
### **STEP 4:** Generate a plan
451451

452-
You can now be specific about the tech stack and other technical requirements. You can use the `/plan` command that is built into the project template with a prompt like this:
452+
You can now be specific about the tech stack and other technical requirements. You can use the `/speckit.plan` command that is built into the project template with a prompt like this:
453453

454454
```text
455455
We are going to generate this using .NET Aspire, using Postgres as the database. The frontend should use
@@ -535,13 +535,13 @@ You can also ask Claude Code (if you have the [GitHub CLI](https://docs.github.c
535535
536536
### STEP 6: Implementation
537537

538-
Once ready, use the `/implement` command to execute your implementation plan:
538+
Once ready, use the `/speckit.implement` command to execute your implementation plan:
539539

540540
```text
541-
/implement
541+
/speckit.implement
542542
```
543543

544-
The `/implement` command will:
544+
The `/speckit.implement` command will:
545545
- Validate that all prerequisites are in place (constitution, spec, plan, and tasks)
546546
- Parse the task breakdown from `tasks.md`
547547
- Execute tasks in the correct order, respecting dependencies and parallel execution markers

docs/installation.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,9 @@ uvx --from git+https://github.com/github/spec-kit.git specify init <project_name
6262
## Verification
6363

6464
After initialization, you should see the following commands available in your AI agent:
65-
- `/specify` - Create specifications
66-
- `/plan` - Generate implementation plans
67-
- `/tasks` - Break down into actionable tasks
65+
- `/speckit.specify` - Create specifications
66+
- `/speckit.plan` - Generate implementation plans
67+
- `/speckit.tasks` - Break down into actionable tasks
6868

6969
The `.specify/scripts` directory will contain both `.sh` and `.ps1` scripts.
7070

docs/quickstart.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,29 +22,29 @@ uvx --from git+https://github.com/github/spec-kit.git specify init <PROJECT_NAME
2222

2323
### 2. Create the Spec
2424

25-
Use the `/specify` command to describe what you want to build. Focus on the **what** and **why**, not the tech stack.
25+
Use the `/speckit.specify` command to describe what you want to build. Focus on the **what** and **why**, not the tech stack.
2626

2727
```bash
28-
/specify Build an application that can help me organize my photos in separate photo albums. Albums are grouped by date and can be re-organized by dragging and dropping on the main page. Albums are never in other nested albums. Within each album, photos are previewed in a tile-like interface.
28+
/speckit.specify Build an application that can help me organize my photos in separate photo albums. Albums are grouped by date and can be re-organized by dragging and dropping on the main page. Albums are never in other nested albums. Within each album, photos are previewed in a tile-like interface.
2929
```
3030

3131
### 3. Create a Technical Implementation Plan
3232

33-
Use the `/plan` command to provide your tech stack and architecture choices.
33+
Use the `/speckit.plan` command to provide your tech stack and architecture choices.
3434

3535
```bash
36-
/plan The application uses Vite with minimal number of libraries. Use vanilla HTML, CSS, and JavaScript as much as possible. Images are not uploaded anywhere and metadata is stored in a local SQLite database.
36+
/speckit.plan The application uses Vite with minimal number of libraries. Use vanilla HTML, CSS, and JavaScript as much as possible. Images are not uploaded anywhere and metadata is stored in a local SQLite database.
3737
```
3838

3939
### 4. Break Down and Implement
4040

41-
Use `/tasks` to create an actionable task list, then ask your agent to implement the feature.
41+
Use `/speckit.tasks` to create an actionable task list, then ask your agent to implement the feature.
4242

4343
## Detailed Example: Building Taskify
4444

4545
Here's a complete example of building a team productivity platform:
4646

47-
### Step 1: Define Requirements with `/specify`
47+
### Step 1: Define Requirements with `/speckit.specify`
4848

4949
```text
5050
Develop Taskify, a team productivity platform. It should allow users to create projects, add team members,
@@ -81,7 +81,7 @@ Also validate the specification checklist:
8181
Read the review and acceptance checklist, and check off each item in the checklist if the feature spec meets the criteria. Leave it empty if it does not.
8282
```
8383

84-
### Step 3: Generate Technical Plan with `/plan`
84+
### Step 3: Generate Technical Plan with `/speckit.plan`
8585

8686
Be specific about your tech stack and technical requirements:
8787

scripts/bash/check-prerequisites.sh

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,20 +102,20 @@ fi
102102
# Validate required directories and files
103103
if [[ ! -d "$FEATURE_DIR" ]]; then
104104
echo "ERROR: Feature directory not found: $FEATURE_DIR" >&2
105-
echo "Run /specify first to create the feature structure." >&2
105+
echo "Run /speckit.specify first to create the feature structure." >&2
106106
exit 1
107107
fi
108108

109109
if [[ ! -f "$IMPL_PLAN" ]]; then
110110
echo "ERROR: plan.md not found in $FEATURE_DIR" >&2
111-
echo "Run /plan first to create the implementation plan." >&2
111+
echo "Run /speckit.plan first to create the implementation plan." >&2
112112
exit 1
113113
fi
114114

115115
# Check for tasks.md if required
116116
if $REQUIRE_TASKS && [[ ! -f "$TASKS" ]]; then
117117
echo "ERROR: tasks.md not found in $FEATURE_DIR" >&2
118-
echo "Run /tasks first to create the task list." >&2
118+
echo "Run /speckit.tasks first to create the task list." >&2
119119
exit 1
120120
fi
121121

scripts/powershell/check-prerequisites.ps1

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,20 +88,20 @@ if ($PathsOnly) {
8888
# Validate required directories and files
8989
if (-not (Test-Path $paths.FEATURE_DIR -PathType Container)) {
9090
Write-Output "ERROR: Feature directory not found: $($paths.FEATURE_DIR)"
91-
Write-Output "Run /specify first to create the feature structure."
91+
Write-Output "Run /speckit.specify first to create the feature structure."
9292
exit 1
9393
}
9494

9595
if (-not (Test-Path $paths.IMPL_PLAN -PathType Leaf)) {
9696
Write-Output "ERROR: plan.md not found in $($paths.FEATURE_DIR)"
97-
Write-Output "Run /plan first to create the implementation plan."
97+
Write-Output "Run /speckit.plan first to create the implementation plan."
9898
exit 1
9999
}
100100

101101
# Check for tasks.md if required
102102
if ($RequireTasks -and -not (Test-Path $paths.TASKS -PathType Leaf)) {
103103
Write-Output "ERROR: tasks.md not found in $($paths.FEATURE_DIR)"
104-
Write-Output "Run /tasks first to create the task list."
104+
Write-Output "Run /speckit.tasks first to create the task list."
105105
exit 1
106106
}
107107

spec-driven.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ The key is treating specifications as the source of truth, with code as the gene
7474

7575
The SDD methodology is significantly enhanced through three powerful commands that automate the specification → planning → tasking workflow:
7676

77-
### The `/specify` Command
77+
### The `/speckit.specify` Command
7878

7979
This command transforms a simple feature description (the user-prompt) into a complete, structured specification with automatic repository management:
8080

@@ -83,7 +83,7 @@ This command transforms a simple feature description (the user-prompt) into a co
8383
3. **Template-Based Generation**: Copies and customizes the feature specification template with your requirements
8484
4. **Directory Structure**: Creates the proper `specs/[branch-name]/` structure for all related documents
8585

86-
### The `/plan` Command
86+
### The `/speckit.plan` Command
8787

8888
Once a feature specification exists, this command creates a comprehensive implementation plan:
8989

@@ -93,7 +93,7 @@ Once a feature specification exists, this command creates a comprehensive implem
9393
4. **Detailed Documentation**: Generates supporting documents for data models, API contracts, and test scenarios
9494
5. **Quickstart Validation**: Produces a quickstart guide capturing key validation scenarios
9595

96-
### The `/tasks` Command
96+
### The `/speckit.tasks` Command
9797

9898
After a plan is created, this command analyzes the plan and related design documents to generate an executable task list:
9999

@@ -121,18 +121,18 @@ Total: ~12 hours of documentation work
121121

122122
```bash
123123
# Step 1: Create the feature specification (5 minutes)
124-
/specify Real-time chat system with message history and user presence
124+
/speckit.specify Real-time chat system with message history and user presence
125125

126126
# This automatically:
127127
# - Creates branch "003-chat-system"
128128
# - Generates specs/003-chat-system/spec.md
129129
# - Populates it with structured requirements
130130

131131
# Step 2: Generate implementation plan (5 minutes)
132-
/plan WebSocket for real-time messaging, PostgreSQL for history, Redis for presence
132+
/speckit.plan WebSocket for real-time messaging, PostgreSQL for history, Redis for presence
133133

134134
# Step 3: Generate executable tasks (5 minutes)
135-
/tasks
135+
/speckit.tasks
136136

137137
# This automatically creates:
138138
# - specs/003-chat-system/plan.md

0 commit comments

Comments
 (0)