mspec 0.0.3 → 0.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -32,7 +32,7 @@ npm install -g mspec
|
|
|
32
32
|
|
|
33
33
|
## How to Use
|
|
34
34
|
|
|
35
|
-
The workflow follows a simple three-step loop: **Initialize -> Plan ->
|
|
35
|
+
The workflow follows a simple three-step loop: **Initialize -> Plan -> Implement**.
|
|
36
36
|
|
|
37
37
|
### Step 1: Initialize the Project
|
|
38
38
|
Run this command in the root of your project:
|
|
@@ -41,7 +41,7 @@ npx mspec init
|
|
|
41
41
|
```
|
|
42
42
|
- It will prompt you for your preferred AI agent (Claude, Gemini, Cursor, etc.).
|
|
43
43
|
- It will create the `.mspec/specs/` and `.mspec/tasks/` directories.
|
|
44
|
-
- It will automatically inject custom commands into your project (e.g., `.gemini/commands/mspec.plan.toml` or `.cursor/rules/mspec.
|
|
44
|
+
- It will automatically inject custom commands into your project (e.g., `.gemini/commands/mspec.plan.toml` or `.cursor/rules/mspec.implement.mdc`) so your AI agent natively understands the framework and provides autocomplete commands like `/mspec.spec`.
|
|
45
45
|
|
|
46
46
|
*(Note: After running `init`, you may need to restart your AI agent session so it can detect the new slash commands).*
|
|
47
47
|
|
|
@@ -73,8 +73,9 @@ Once the checklist is generated, hand the wheel over to the AI to orchestrate th
|
|
|
73
73
|
|
|
74
74
|
**Command:**
|
|
75
75
|
```text
|
|
76
|
-
/mspec.
|
|
76
|
+
/mspec.implement
|
|
77
77
|
```
|
|
78
|
+
- If you don't provide a spec name, the AI will ask you which spec you want to implement.
|
|
78
79
|
- **Sub-Agent Delegation:** To prevent context bloat, the AI will read the first `- [ ]` task and delegate the actual coding to a sub-agent.
|
|
79
80
|
- **Parallelization:** If tasks are independent (e.g., backend and frontend), it will spawn multiple sub-agents to execute them simultaneously!
|
|
80
81
|
- **Empirical Verification:** The sub-agent will write the code, autonomously run your tests/linters, fix any errors, and only report back when the build is green.
|
|
@@ -107,7 +108,7 @@ your-project/
|
|
|
107
108
|
│ └── commands/
|
|
108
109
|
│ ├── mspec.spec.toml
|
|
109
110
|
│ ├── mspec.plan.toml
|
|
110
|
-
│ └── mspec.
|
|
111
|
+
│ └── mspec.implement.toml
|
|
111
112
|
├── src/ # Your actual code
|
|
112
113
|
└── package.json
|
|
113
114
|
```
|