Skip to content

Commit 58615a3

Browse files
committed
fix: update command prefixes from /speckit.* to /spec.* in README
1 parent 29876b8 commit 58615a3

1 file changed

Lines changed: 34 additions & 34 deletions

File tree

README.md

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -147,44 +147,44 @@ If your environment blocks access to PyPI or GitHub, see the [Enterprise / Air-G
147147

148148
### 2. Establish project principles
149149

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.
151151

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.
153153

154154
```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
156156
```
157157

158158
### 3. Create the spec
159159

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.
161161

162162
```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.
164164
```
165165

166166
### 4. Create a technical implementation plan
167167

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.
169169

170170
```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.
172172
```
173173

174174
### 5. Break down into tasks
175175

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.
177177

178178
```bash
179-
/speckit.tasks
179+
/spec.tasks
180180
```
181181

182182
### 6. Execute implementation
183183

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.
185185

186186
```bash
187-
/speckit.implement
187+
/spec.implement
188188
```
189189

190190
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:
422422

423423
| Command | Agent Skill | Description |
424424
| ------------------------ | ---------------------- | -------------------------------------------------------------------------- |
425-
| `/speckit.constitution` | `speckit-constitution` | Create or update project governing principles and development guidelines |
426-
| `/speckit.specify` | `speckit-specify` | Define what you want to build (requirements and user stories) |
427-
| `/speckit.plan` | `speckit-plan` | Create technical implementation plans with your chosen tech stack |
428-
| `/speckit.tasks` | `speckit-tasks` | Generate actionable task lists for implementation |
429-
| `/speckit.taskstoissues` | `speckit-taskstoissues`| Convert generated task lists into GitHub issues for tracking and execution |
430-
| `/speckit.implement` | `speckit-implement` | Execute all tasks to build the feature according to the plan |
425+
| `/spec.constitution` | `speckit-constitution` | Create or update project governing principles and development guidelines |
426+
| `/spec.specify` | `speckit-specify` | Define what you want to build (requirements and user stories) |
427+
| `/spec.plan` | `speckit-plan` | Create technical implementation plans with your chosen tech stack |
428+
| `/spec.tasks` | `speckit-tasks` | Generate actionable task lists for implementation |
429+
| `/spec.taskstoissues` | `speckit-taskstoissues`| Convert generated task lists into GitHub issues for tracking and execution |
430+
| `/spec.implement` | `speckit-implement` | Execute all tasks to build the feature according to the plan |
431431

432432
#### Optional Commands
433433

434434
Additional commands for enhanced quality and validation:
435435

436436
| Command | Agent Skill | Description |
437437
| -------------------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
438-
| `/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") |
441441

442442
## 🔧 Specify CLI Reference
443443

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

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

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.
625625

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:
627627

628628
```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.
630630
```
631631

632632
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.
633633

634634
### **STEP 2:** Create project specifications
635635

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.
637637

638638
> [!IMPORTANT]
639639
> 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
694694

695695
Preferred order:
696696

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.
698698
2. Optionally follow up with ad-hoc free-form refinement if something still feels vague.
699699

700700
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.
701701

702-
Example free-form refinement prompt (after `/speckit.clarify` if still needed):
702+
Example free-form refinement prompt (after `/spec.clarify` if still needed):
703703

704704
```text
705705
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
717717

718718
### **STEP 4:** Generate a plan
719719

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:
721721

722722
```text
723723
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
801801
> [!NOTE]
802802
> 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.
803803
804-
### **STEP 6:** Generate task breakdown with /speckit.tasks
804+
### **STEP 6:** Generate task breakdown with /spec.tasks
805805

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:
807807

808808
```text
809-
/speckit.tasks
809+
/spec.tasks
810810
```
811811

812812
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
818818
- **Test-driven development structure** - If tests are requested, test tasks are included and ordered to be written before implementation
819819
- **Checkpoint validation** - Each user story phase includes checkpoints to validate independent functionality
820820

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.
822822

823823
### **STEP 7:** Implementation
824824

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:
826826

827827
```text
828-
/speckit.implement
828+
/spec.implement
829829
```
830830

831-
The `/speckit.implement` command will:
831+
The `/spec.implement` command will:
832832

833833
- Validate that all prerequisites are in place (constitution, spec, plan, and tasks)
834834
- Parse the task breakdown from `tasks.md`

0 commit comments

Comments
 (0)