You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+34-34Lines changed: 34 additions & 34 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -147,44 +147,44 @@ If your environment blocks access to PyPI or GitHub, see the [Enterprise / Air-G
147
147
148
148
### 2. Establish project principles
149
149
150
-
Launch your AI assistant in the project directory. Most agents expose spec-kit as `/speckit.*` slash commands; Codex CLI in skills mode uses `$speckit-*` instead.
150
+
Launch your AI assistant in the project directory. Most agents expose spec-kit as `/spec.*` slash commands; Codex CLI in skills mode uses `$speckit-*` instead.
151
151
152
-
Use the **`/speckit.constitution`** command to create your project's governing principles and development guidelines that will guide all subsequent development.
152
+
Use the **`/spec.constitution`** command to create your project's governing principles and development guidelines that will guide all subsequent development.
153
153
154
154
```bash
155
-
/speckit.constitution Create principles focused on code quality, testing standards, user experience consistency, and performance requirements
155
+
/spec.constitution Create principles focused on code quality, testing standards, user experience consistency, and performance requirements
156
156
```
157
157
158
158
### 3. Create the spec
159
159
160
-
Use the **`/speckit.specify`** command to describe what you want to build. Focus on the **what** and **why**, not the tech stack.
160
+
Use the **`/spec.specify`** command to describe what you want to build. Focus on the **what** and **why**, not the tech stack.
161
161
162
162
```bash
163
-
/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.
163
+
/spec.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.
164
164
```
165
165
166
166
### 4. Create a technical implementation plan
167
167
168
-
Use the **`/speckit.plan`** command to provide your tech stack and architecture choices.
168
+
Use the **`/spec.plan`** command to provide your tech stack and architecture choices.
169
169
170
170
```bash
171
-
/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.
171
+
/spec.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.
172
172
```
173
173
174
174
### 5. Break down into tasks
175
175
176
-
Use **`/speckit.tasks`** to create an actionable task list from your implementation plan.
176
+
Use **`/spec.tasks`** to create an actionable task list from your implementation plan.
177
177
178
178
```bash
179
-
/speckit.tasks
179
+
/spec.tasks
180
180
```
181
181
182
182
### 6. Execute implementation
183
183
184
-
Use **`/speckit.implement`** to execute all tasks and build your feature according to the plan.
184
+
Use **`/spec.implement`** to execute all tasks and build your feature according to the plan.
185
185
186
186
```bash
187
-
/speckit.implement
187
+
/spec.implement
188
188
```
189
189
190
190
For detailed step-by-step instructions, see our [comprehensive guide](./spec-driven.md).
@@ -422,22 +422,22 @@ Essential commands for the Spec-Driven Development workflow:
|`/speckit.clarify`|`speckit-clarify`| Clarify underspecified areas (recommended before `/speckit.plan`; formerly `/quizme`) |
439
-
|`/speckit.analyze`|`speckit-analyze`| Cross-artifact consistency & coverage analysis (run after `/speckit.tasks`, before `/speckit.implement`) |
440
-
|`/speckit.checklist`|`speckit-checklist`| Generate custom quality checklists that validate requirements completeness, clarity, and consistency (like "unit tests for English") |
438
+
|`/spec.clarify`|`speckit-clarify`| Clarify underspecified areas (recommended before `/spec.plan`; formerly `/quizme`) |
439
+
|`/spec.analyze`|`speckit-analyze`| Cross-artifact consistency & coverage analysis (run after `/spec.tasks`, before `/spec.implement`) |
440
+
|`/spec.checklist`|`speckit-checklist`| Generate custom quality checklists that validate requirements completeness, clarity, and consistency (like "unit tests for English") |
441
441
442
442
## 🔧 Specify CLI Reference
443
443
@@ -621,19 +621,19 @@ Go to the project folder and run your AI agent. In our example, we're using `cla
621
621
622
622

623
623
624
-
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.
624
+
You will know that things are configured correctly if you see the `/spec.constitution`, `/spec.specify`, `/spec.plan`, `/spec.tasks`, and `/spec.implement` commands available.
625
625
626
-
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:
626
+
The first step should be establishing your project's governing principles using the `/spec.constitution` command. This helps ensure consistent decision-making throughout all subsequent development phases:
627
627
628
628
```text
629
-
/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.
629
+
/spec.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.
630
630
```
631
631
632
632
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.
633
633
634
634
### **STEP 2:** Create project specifications
635
635
636
-
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.
636
+
With your project principles established, you can now create the functional specifications. Use the `/spec.specify` command and then provide the concrete requirements for the project you want to develop.
637
637
638
638
> [!IMPORTANT]
639
639
> Be as explicit as possible about *what* you are trying to build and *why*. **Do not focus on the tech stack at this point**.
@@ -694,12 +694,12 @@ You should run the structured clarification workflow **before** creating a techn
694
694
695
695
Preferred order:
696
696
697
-
1. Use `/speckit.clarify` (structured) – sequential, coverage-based questioning that records answers in a Clarifications section.
697
+
1. Use `/spec.clarify` (structured) – sequential, coverage-based questioning that records answers in a Clarifications section.
698
698
2. Optionally follow up with ad-hoc free-form refinement if something still feels vague.
699
699
700
700
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.
701
701
702
-
Example free-form refinement prompt (after `/speckit.clarify` if still needed):
702
+
Example free-form refinement prompt (after `/spec.clarify` if still needed):
703
703
704
704
```text
705
705
For each sample project or project that you create there should be a variable number of tasks between 5 and 15
@@ -717,7 +717,7 @@ It's important to use the interaction with Claude Code as an opportunity to clar
717
717
718
718
### **STEP 4:** Generate a plan
719
719
720
-
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:
720
+
You can now be specific about the tech stack and other technical requirements. You can use the `/spec.plan` command that is built into the project template with a prompt like this:
721
721
722
722
```text
723
723
We are going to generate this using .NET Aspire, using Postgres as the database. The frontend should use
@@ -801,12 +801,12 @@ You can also ask Claude Code (if you have the [GitHub CLI](https://docs.github.c
801
801
> [!NOTE]
802
802
> Before you have the agent implement it, it's also worth prompting Claude Code to cross-check the details to see if there are any over-engineered pieces (remember - it can be over-eager). If over-engineered components or decisions exist, you can ask Claude Code to resolve them. Ensure that Claude Code follows the [constitution](base/memory/constitution.md) as the foundational piece that it must adhere to when establishing the plan.
803
803
804
-
### **STEP 6:** Generate task breakdown with /speckit.tasks
804
+
### **STEP 6:** Generate task breakdown with /spec.tasks
805
805
806
-
With the implementation plan validated, you can now break down the plan into specific, actionable tasks that can be executed in the correct order. Use the `/speckit.tasks` command to automatically generate a detailed task breakdown from your implementation plan:
806
+
With the implementation plan validated, you can now break down the plan into specific, actionable tasks that can be executed in the correct order. Use the `/spec.tasks` command to automatically generate a detailed task breakdown from your implementation plan:
807
807
808
808
```text
809
-
/speckit.tasks
809
+
/spec.tasks
810
810
```
811
811
812
812
This step creates a `tasks.md` file in your feature specification directory that contains:
@@ -818,17 +818,17 @@ This step creates a `tasks.md` file in your feature specification directory that
818
818
-**Test-driven development structure** - If tests are requested, test tasks are included and ordered to be written before implementation
819
819
-**Checkpoint validation** - Each user story phase includes checkpoints to validate independent functionality
820
820
821
-
The generated tasks.md provides a clear roadmap for the `/speckit.implement` command, ensuring systematic implementation that maintains code quality and allows for incremental delivery of user stories.
821
+
The generated tasks.md provides a clear roadmap for the `/spec.implement` command, ensuring systematic implementation that maintains code quality and allows for incremental delivery of user stories.
822
822
823
823
### **STEP 7:** Implementation
824
824
825
-
Once ready, use the `/speckit.implement` command to execute your implementation plan:
825
+
Once ready, use the `/spec.implement` command to execute your implementation plan:
826
826
827
827
```text
828
-
/speckit.implement
828
+
/spec.implement
829
829
```
830
830
831
-
The `/speckit.implement` command will:
831
+
The `/spec.implement` command will:
832
832
833
833
- Validate that all prerequisites are in place (constitution, spec, plan, and tasks)
0 commit comments