speccrew 0.1.0 → 0.1.2
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.ar.md +98 -91
- package/README.bn.md +122 -0
- package/README.bs.md +321 -0
- package/README.da.md +321 -0
- package/README.de.md +321 -0
- package/README.el.md +122 -0
- package/README.en.md +92 -85
- package/README.es.md +96 -89
- package/README.fr.md +321 -0
- package/README.it.md +321 -0
- package/README.ja.md +321 -0
- package/README.ko.md +321 -0
- package/README.md +92 -109
- package/README.no.md +321 -0
- package/README.pl.md +321 -0
- package/README.pt-BR.md +321 -0
- package/README.ru.md +321 -0
- package/README.th.md +239 -0
- package/README.tr.md +239 -0
- package/README.uk.md +239 -0
- package/README.vi.md +122 -0
- package/README.zh-TW.md +321 -0
- package/bin/cli.js +5 -1
- package/bin/postinstall.js +157 -0
- package/docs/GETTING-STARTED.ar.md +452 -0
- package/docs/GETTING-STARTED.bn.md +449 -0
- package/docs/GETTING-STARTED.bs.md +449 -0
- package/docs/GETTING-STARTED.da.md +448 -0
- package/docs/GETTING-STARTED.de.md +448 -0
- package/docs/GETTING-STARTED.el.md +449 -0
- package/docs/GETTING-STARTED.en.md +448 -0
- package/docs/GETTING-STARTED.es.md +448 -0
- package/docs/GETTING-STARTED.fr.md +448 -0
- package/docs/GETTING-STARTED.it.md +448 -0
- package/docs/GETTING-STARTED.ja.md +448 -0
- package/docs/GETTING-STARTED.ko.md +448 -0
- package/docs/GETTING-STARTED.md +448 -0
- package/docs/GETTING-STARTED.no.md +449 -0
- package/docs/GETTING-STARTED.pl.md +449 -0
- package/docs/GETTING-STARTED.pt-BR.md +449 -0
- package/docs/GETTING-STARTED.ru.md +449 -0
- package/docs/GETTING-STARTED.th.md +449 -0
- package/docs/GETTING-STARTED.tr.md +449 -0
- package/docs/GETTING-STARTED.uk.md +449 -0
- package/docs/GETTING-STARTED.vi.md +449 -0
- package/docs/GETTING-STARTED.zh-TW.md +448 -0
- package/lib/commands/init.js +238 -41
- package/lib/commands/uninstall.js +150 -32
- package/lib/commands/update.js +159 -24
- package/lib/ide-adapters.js +257 -3
- package/lib/utils.js +23 -7
- package/package.json +16 -5
package/README.en.md
CHANGED
|
@@ -1,10 +1,34 @@
|
|
|
1
1
|
# SpecCrew - AI-Driven Software Engineering Framework
|
|
2
2
|
|
|
3
3
|
<p align="center">
|
|
4
|
-
<a href="./README.md"
|
|
4
|
+
<a href="./README.md">简体中文</a> |
|
|
5
|
+
<a href="./README.zh-TW.md">繁體中文</a> |
|
|
5
6
|
<a href="./README.en.md">English</a> |
|
|
7
|
+
<a href="./README.ko.md">한국어</a> |
|
|
8
|
+
<a href="./README.de.md">Deutsch</a> |
|
|
9
|
+
<a href="./README.es.md">Español</a> |
|
|
10
|
+
<a href="./README.fr.md">Français</a> |
|
|
11
|
+
<a href="./README.it.md">Italiano</a> |
|
|
12
|
+
<a href="./README.da.md">Dansk</a> |
|
|
13
|
+
<a href="./README.ja.md">日本語</a> |
|
|
14
|
+
<a href="./README.pl.md">Polski</a> |
|
|
15
|
+
<a href="./README.ru.md">Русский</a> |
|
|
16
|
+
<a href="./README.bs.md">Bosanski</a> |
|
|
6
17
|
<a href="./README.ar.md">العربية</a> |
|
|
7
|
-
<a href="./README.
|
|
18
|
+
<a href="./README.no.md">Norsk</a> |
|
|
19
|
+
<a href="./README.pt-BR.md">Português (Brasil)</a> |
|
|
20
|
+
<a href="./README.th.md">ไทย</a> |
|
|
21
|
+
<a href="./README.tr.md">Türkçe</a> |
|
|
22
|
+
<a href="./README.uk.md">Українська</a> |
|
|
23
|
+
<a href="./README.bn.md">বাংলা</a> |
|
|
24
|
+
<a href="./README.el.md">Ελληνικά</a> |
|
|
25
|
+
<a href="./README.vi.md">Tiếng Việt</a>
|
|
26
|
+
</p>
|
|
27
|
+
|
|
28
|
+
<p align="center">
|
|
29
|
+
<a href="https://www.npmjs.com/package/speccrew"><img src="https://img.shields.io/npm/v/speccrew.svg" alt="npm version"></a>
|
|
30
|
+
<a href="https://www.npmjs.com/package/speccrew"><img src="https://img.shields.io/npm/dm/speccrew.svg" alt="npm downloads"></a>
|
|
31
|
+
<a href="https://github.com/charlesmu99/speccrew/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/speccrew.svg" alt="license"></a>
|
|
8
32
|
</p>
|
|
9
33
|
|
|
10
34
|
> A virtual AI development team that enables rapid engineering implementation for any software project
|
|
@@ -93,7 +117,7 @@ graph LR
|
|
|
93
117
|
B --> C[API Contract<br/>Interface Contract]
|
|
94
118
|
C --> D[Design<br/>Detailed Design]
|
|
95
119
|
D --> E[Dev<br/>Implementation]
|
|
96
|
-
E --> F[Test<br/>Testing]
|
|
120
|
+
E --> F[System Test<br/>Testing]
|
|
97
121
|
F --> G[Archive<br/>Archiving]
|
|
98
122
|
|
|
99
123
|
H[Knowledge<br/>Repository] -.-> A
|
|
@@ -113,7 +137,7 @@ graph LR
|
|
|
113
137
|
| Solution | Planner | PRD | Technical Solution + API Contract | ✅ Required |
|
|
114
138
|
| Design | Designer | Solution | Frontend/Backend Design Documents | ✅ Required |
|
|
115
139
|
| Dev | Dev | Design | Code + Task Records | ✅ Required |
|
|
116
|
-
| Test | Test | Dev Output +
|
|
140
|
+
| System Test | Test Manager | Dev Output + Feature Spec | Test Cases + Test Code + Test Report + Bug Report | ✅ Required |
|
|
117
141
|
|
|
118
142
|
---
|
|
119
143
|
|
|
@@ -134,100 +158,71 @@ graph LR
|
|
|
134
158
|
|
|
135
159
|
## Quick Start
|
|
136
160
|
|
|
137
|
-
###
|
|
138
|
-
|
|
139
|
-
**Method 1: One-click Install Script (Recommended, Qoder IDE only)**
|
|
140
|
-
|
|
141
|
-
```bash
|
|
142
|
-
# macOS / Linux / WSL - Install from GitHub
|
|
143
|
-
curl -fsSL https://raw.githubusercontent.com/charlesmu99/SpecCrew/main/scripts/install-qoder.sh | bash
|
|
144
|
-
|
|
145
|
-
# macOS / Linux / WSL - Install from Gitee (China Mirror)
|
|
146
|
-
curl -fsSL https://gitee.com/amutek/speccrew/raw/main/scripts/install-qoder.sh | bash
|
|
147
|
-
```
|
|
161
|
+
### Prerequisites
|
|
148
162
|
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
Invoke-Expression (Invoke-WebRequest -Uri "https://raw.githubusercontent.com/charlesmu99/SpecCrew/main/scripts/install-qoder.ps1").Content
|
|
163
|
+
- Node.js >= 16.0.0
|
|
164
|
+
- Supported IDEs: Qoder (default), Cursor, Claude Code
|
|
152
165
|
|
|
153
|
-
|
|
154
|
-
Invoke-Expression (Invoke-WebRequest -Uri "https://gitee.com/amutek/speccrew/raw/main/scripts/install-qoder.ps1").Content
|
|
155
|
-
```
|
|
156
|
-
|
|
157
|
-
> **Note**: One-click installation script currently only supports Qoder IDE. For other IDEs (VS Code, Cursor, etc.), please use manual copy method below.
|
|
166
|
+
> **Note**: The adapters for Cursor and Claude Code have not been tested in actual IDE environments (implemented at the code level and verified through E2E tests, but not yet tested in real Cursor/Claude Code).
|
|
158
167
|
|
|
159
|
-
|
|
168
|
+
### 1. Install SpecCrew
|
|
160
169
|
|
|
161
170
|
```bash
|
|
162
|
-
|
|
163
|
-
git clone https://github.com/charlesmu99/speccrew.git
|
|
164
|
-
# or: git clone https://gitee.com/amutek/speccrew.git
|
|
165
|
-
|
|
166
|
-
# Copy to target project (adjust based on your IDE config directory)
|
|
167
|
-
cp -r SpecCrew/.speccrew /path/to/your-project/
|
|
168
|
-
cp -r SpecCrew/SpecCrew-workspace /path/to/your-project/
|
|
169
|
-
|
|
170
|
-
# For Qoder IDE, also copy to .qoder/ directory
|
|
171
|
-
cp -r SpecCrew/.speccrew/agents/* /path/to/your-project/.qoder/agents/
|
|
172
|
-
cp -r SpecCrew/.speccrew/skills/* /path/to/your-project/.qoder/skills/
|
|
171
|
+
npm install -g speccrew
|
|
173
172
|
```
|
|
174
173
|
|
|
175
174
|
### 2. Initialize Project
|
|
176
175
|
|
|
176
|
+
Navigate to your project root directory and run the initialization command:
|
|
177
|
+
|
|
177
178
|
```bash
|
|
178
|
-
|
|
179
|
-
# Executed automatically by speccrew-project-init Skill
|
|
180
|
-
```
|
|
179
|
+
cd /path/to/your-project
|
|
181
180
|
|
|
182
|
-
|
|
181
|
+
# Default uses Qoder
|
|
182
|
+
speccrew init
|
|
183
183
|
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
# 4. Detailed Design
|
|
189
|
-
# 5. Development Implementation
|
|
190
|
-
# 6. Testing
|
|
184
|
+
# Or specify IDE
|
|
185
|
+
speccrew init --ide qoder
|
|
186
|
+
speccrew init --ide cursor
|
|
187
|
+
speccrew init --ide claude
|
|
191
188
|
```
|
|
192
189
|
|
|
193
|
-
|
|
190
|
+
After initialization, the following will be generated in your project:
|
|
191
|
+
- `.qoder/agents/` / `.cursor/agents/` / `.claude/agents/` — 7 Agent role definitions
|
|
192
|
+
- `.qoder/skills/` / `.cursor/skills/` / `.claude/skills/` — 38 Skill workflows
|
|
193
|
+
- `speccrew-workspace/` — Workspace (iteration directories, knowledge base, document templates)
|
|
194
|
+
- `.speccrewrc` — SpecCrew configuration file
|
|
194
195
|
|
|
195
|
-
|
|
196
|
+
To update Agents and Skills for a specific IDE later:
|
|
196
197
|
|
|
197
198
|
```bash
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
# macOS / Linux / WSL - Uninstall from Gitee (China Mirror)
|
|
202
|
-
curl -fsSL https://gitee.com/amutek/speccrew/raw/main/scripts/uninstall-qoder.sh | bash
|
|
199
|
+
speccrew update --ide cursor
|
|
200
|
+
speccrew update --ide claude
|
|
203
201
|
```
|
|
204
202
|
|
|
205
|
-
|
|
206
|
-
# Windows - Uninstall from GitHub
|
|
207
|
-
Invoke-Expression (Invoke-WebRequest -Uri "https://raw.githubusercontent.com/charlesmu99/SpecCrew/main/scripts/uninstall-qoder.ps1").Content
|
|
208
|
-
|
|
209
|
-
# Windows - Uninstall from Gitee (China Mirror)
|
|
210
|
-
Invoke-Expression (Invoke-WebRequest -Uri "https://gitee.com/amutek/speccrew/raw/main/scripts/uninstall-qoder.ps1").Content
|
|
211
|
-
```
|
|
203
|
+
### 3. Start Development Workflow
|
|
212
204
|
|
|
213
|
-
|
|
205
|
+
Follow the standard engineering workflow step by step:
|
|
214
206
|
|
|
215
|
-
**
|
|
207
|
+
1. **PRD**: Product Manager Agent analyzes requirements and generates product requirements document
|
|
208
|
+
2. **Feature Design**: Feature Designer Agent generates feature design document + API contract
|
|
209
|
+
3. **System Design**: System Designer Agent generates system design documents by platform (frontend/backend/mobile/desktop)
|
|
210
|
+
4. **Dev**: System Developer Agent implements development by platform in parallel
|
|
211
|
+
5. **System Test**: Test Manager Agent coordinates three-phase testing (case design → code generation → execution report)
|
|
212
|
+
6. **Archive**: Archive iteration
|
|
216
213
|
|
|
217
|
-
|
|
218
|
-
# Remove speccrew-workspace directory
|
|
219
|
-
rm -rf speccrew-workspace/
|
|
214
|
+
> Each phase's deliverables require human confirmation before proceeding to the next phase.
|
|
220
215
|
|
|
221
|
-
|
|
222
|
-
rm -rf .speccrew/agents/SpecCrew-*.md
|
|
223
|
-
rm -rf .speccrew/skills/SpecCrew-*/
|
|
216
|
+
### 4. Other CLI Commands
|
|
224
217
|
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
218
|
+
```bash
|
|
219
|
+
speccrew list # List installed agents and skills
|
|
220
|
+
speccrew doctor # Diagnose environment and installation status
|
|
221
|
+
speccrew update # Update agents and skills to latest version
|
|
222
|
+
speccrew uninstall # Uninstall SpecCrew (--all also removes workspace)
|
|
228
223
|
```
|
|
229
224
|
|
|
230
|
-
|
|
225
|
+
📖 **Detailed Guide**: After installation, check the [Getting Started Guide](docs/GETTING-STARTED.en.md) for the complete workflow and agent conversation guide.
|
|
231
226
|
|
|
232
227
|
---
|
|
233
228
|
|
|
@@ -235,40 +230,51 @@ rm -rf .qoder/skills/SpecCrew-*/
|
|
|
235
230
|
|
|
236
231
|
```
|
|
237
232
|
your-project/
|
|
238
|
-
├── .
|
|
239
|
-
├──
|
|
240
|
-
│ ├──
|
|
241
|
-
│
|
|
233
|
+
├── .qoder/ # IDE configuration directory (Qoder example)
|
|
234
|
+
│ ├── agents/ # 7 role Agents
|
|
235
|
+
│ │ ├── speccrew-team-leader.md # Team Leader: Global scheduling and iteration management
|
|
236
|
+
│ │ ├── speccrew-product-manager.md # Product Manager: Requirements analysis and PRD
|
|
237
|
+
│ │ ├── speccrew-feature-designer.md # Feature Designer: Feature Design + API Contract
|
|
238
|
+
│ │ ├── speccrew-system-designer.md # System Designer: System design by platform
|
|
239
|
+
│ │ ├── speccrew-system-developer.md # System Developer: Parallel development by platform
|
|
240
|
+
│ │ ├── speccrew-test-manager.md # Test Manager: Three-phase testing coordination
|
|
241
|
+
│ │ └── speccrew-task-worker.md # Task Worker: Parallel subtask execution
|
|
242
|
+
│ └── skills/ # 38 Skills (grouped by function)
|
|
243
|
+
│ ├── speccrew-pm-*/ # Product Management (requirements analysis, evaluation)
|
|
244
|
+
│ ├── speccrew-fd-*/ # Feature Design (Feature Design, API Contract)
|
|
245
|
+
│ ├── speccrew-sd-*/ # System Design (frontend/backend/mobile/desktop)
|
|
246
|
+
│ ├── speccrew-dev-*/ # Development (frontend/backend/mobile/desktop)
|
|
247
|
+
│ ├── speccrew-test-*/ # Testing (case design/code generation/execution report)
|
|
248
|
+
│ ├── speccrew-knowledge-bizs-*/ # Business Knowledge (API analysis/UI analysis/module classification, etc.)
|
|
249
|
+
│ ├── speccrew-knowledge-techs-*/ # Technical Knowledge (tech stack generation/conventions/index, etc.)
|
|
250
|
+
│ ├── speccrew-knowledge-graph-*/ # Knowledge Graph (read/write/query)
|
|
251
|
+
│ └── speccrew-*/ # Utilities (diagnostics/timestamps/workflow, etc.)
|
|
242
252
|
│
|
|
243
253
|
└── speccrew-workspace/ # Workspace (generated during initialization)
|
|
244
254
|
├── docs/ # Management documents
|
|
255
|
+
│ ├── configs/ # Configuration files (platform mapping, tech stack mapping, etc.)
|
|
245
256
|
│ ├── rules/ # Rule configurations
|
|
246
257
|
│ └── solutions/ # Solution documents
|
|
247
|
-
│ └── agent-knowledge-map.md
|
|
248
258
|
│
|
|
249
259
|
├── iterations/ # Iteration projects (dynamically generated)
|
|
250
|
-
│ └── {number}-{type}-{name}/
|
|
260
|
+
│ └── {number}-{type}-{name}/
|
|
251
261
|
│ ├── 00.docs/ # Original requirements
|
|
252
262
|
│ ├── 01.product-requirement/ # Product requirements
|
|
253
263
|
│ ├── 02.feature-design/ # Feature design
|
|
254
264
|
│ ├── 03.system-design/ # System design
|
|
255
265
|
│ ├── 04.development/ # Development phase
|
|
256
|
-
│ ├── 05.test/
|
|
266
|
+
│ ├── 05.system-test/ # System testing
|
|
257
267
|
│ └── 06.delivery/ # Delivery phase
|
|
258
268
|
│
|
|
259
269
|
├── iteration-archives/ # Iteration archives
|
|
260
|
-
│ └── {number}-{type}-{name}-{date}/
|
|
261
270
|
│
|
|
262
271
|
└── knowledges/ # Knowledge base
|
|
263
|
-
├── base/ # Base
|
|
272
|
+
├── base/ # Base/metadata
|
|
264
273
|
│ ├── diagnosis-reports/ # Diagnosis reports
|
|
265
274
|
│ ├── sync-state/ # Sync state
|
|
266
275
|
│ └── tech-debts/ # Technical debts
|
|
267
|
-
│
|
|
268
276
|
├── bizs/ # Business knowledge
|
|
269
|
-
│ └── {platform-type}/
|
|
270
|
-
│ └── {module-name}/
|
|
271
|
-
│
|
|
277
|
+
│ └── {platform-type}/{module-name}/
|
|
272
278
|
└── techs/ # Technical knowledge
|
|
273
279
|
└── {platform-id}/
|
|
274
280
|
```
|
|
@@ -305,6 +311,7 @@ your-project/
|
|
|
305
311
|
## More Information
|
|
306
312
|
|
|
307
313
|
- **Agent Knowledge Map**: [speccrew-workspace/docs/agent-knowledge-map.md](./speccrew-workspace/docs/agent-knowledge-map.md)
|
|
314
|
+
- **npm**: https://www.npmjs.com/package/speccrew
|
|
308
315
|
- **GitHub**: https://github.com/charlesmu99/speccrew
|
|
309
316
|
- **Gitee**: https://gitee.com/amutek/speccrew
|
|
310
317
|
- **Qoder IDE**: https://qoder.com/
|
package/README.es.md
CHANGED
|
@@ -1,10 +1,34 @@
|
|
|
1
1
|
# SpecCrew - Framework de Ingeniería de Software Impulsado por IA
|
|
2
2
|
|
|
3
3
|
<p align="center">
|
|
4
|
-
<a href="./README.md"
|
|
4
|
+
<a href="./README.md">简体中文</a> |
|
|
5
|
+
<a href="./README.zh-TW.md">繁體中文</a> |
|
|
5
6
|
<a href="./README.en.md">English</a> |
|
|
7
|
+
<a href="./README.ko.md">한국어</a> |
|
|
8
|
+
<a href="./README.de.md">Deutsch</a> |
|
|
9
|
+
<a href="./README.es.md">Español</a> |
|
|
10
|
+
<a href="./README.fr.md">Français</a> |
|
|
11
|
+
<a href="./README.it.md">Italiano</a> |
|
|
12
|
+
<a href="./README.da.md">Dansk</a> |
|
|
13
|
+
<a href="./README.ja.md">日本語</a> |
|
|
14
|
+
<a href="./README.pl.md">Polski</a> |
|
|
15
|
+
<a href="./README.ru.md">Русский</a> |
|
|
16
|
+
<a href="./README.bs.md">Bosanski</a> |
|
|
6
17
|
<a href="./README.ar.md">العربية</a> |
|
|
7
|
-
<a href="./README.
|
|
18
|
+
<a href="./README.no.md">Norsk</a> |
|
|
19
|
+
<a href="./README.pt-BR.md">Português (Brasil)</a> |
|
|
20
|
+
<a href="./README.th.md">ไทย</a> |
|
|
21
|
+
<a href="./README.tr.md">Türkçe</a> |
|
|
22
|
+
<a href="./README.uk.md">Українська</a> |
|
|
23
|
+
<a href="./README.bn.md">বাংলা</a> |
|
|
24
|
+
<a href="./README.el.md">Ελληνικά</a> |
|
|
25
|
+
<a href="./README.vi.md">Tiếng Việt</a>
|
|
26
|
+
</p>
|
|
27
|
+
|
|
28
|
+
<p align="center">
|
|
29
|
+
<a href="https://www.npmjs.com/package/speccrew"><img src="https://img.shields.io/npm/v/speccrew.svg" alt="npm version"></a>
|
|
30
|
+
<a href="https://www.npmjs.com/package/speccrew"><img src="https://img.shields.io/npm/dm/speccrew.svg" alt="npm downloads"></a>
|
|
31
|
+
<a href="https://github.com/charlesmu99/speccrew/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/speccrew.svg" alt="license"></a>
|
|
8
32
|
</p>
|
|
9
33
|
|
|
10
34
|
> Un equipo de desarrollo virtual de IA que permite la implementación de ingeniería rápida para cualquier proyecto de software
|
|
@@ -93,7 +117,7 @@ graph LR
|
|
|
93
117
|
B --> C[API Contract<br/>Contrato de Interfaz]
|
|
94
118
|
C --> D[Design<br/>Diseño Detallado]
|
|
95
119
|
D --> E[Dev<br/>Implementación]
|
|
96
|
-
E --> F[Test<br/>Pruebas]
|
|
120
|
+
E --> F[System Test<br/>Pruebas del Sistema]
|
|
97
121
|
F --> G[Archive<br/>Archivado]
|
|
98
122
|
|
|
99
123
|
H[Knowledge<br/>Repositorio] -.-> A
|
|
@@ -113,7 +137,7 @@ graph LR
|
|
|
113
137
|
| Solution | Planner | PRD | Solución Técnica + Contrato API | ✅ Requerido |
|
|
114
138
|
| Design | Designer | Solution | Documentos de Diseño Frontend/Backend | ✅ Requerido |
|
|
115
139
|
| Dev | Dev | Design | Código + Registros de Tareas | ✅ Requerido |
|
|
116
|
-
| Test | Test | Salida Dev +
|
|
140
|
+
| System Test | Test Manager | Salida Dev + Feature Spec | Casos de Prueba + Código de Prueba + Reporte de Pruebas + Reporte de Bugs | ✅ Requerido |
|
|
117
141
|
|
|
118
142
|
---
|
|
119
143
|
|
|
@@ -134,100 +158,71 @@ graph LR
|
|
|
134
158
|
|
|
135
159
|
## Inicio Rápido
|
|
136
160
|
|
|
137
|
-
###
|
|
138
|
-
|
|
139
|
-
**Método 1: Script de Instalación con Un Clic (Recomendado, solo Qoder IDE)**
|
|
140
|
-
|
|
141
|
-
```bash
|
|
142
|
-
# macOS / Linux / WSL - Instalar desde GitHub
|
|
143
|
-
curl -fsSL https://raw.githubusercontent.com/charlesmu99/SpecCrew/main/scripts/install-qoder.sh | bash
|
|
144
|
-
|
|
145
|
-
# macOS / Linux / WSL - Instalar desde Gitee (Espejo de China)
|
|
146
|
-
curl -fsSL https://gitee.com/amutek/speccrew/raw/main/scripts/install-qoder.sh | bash
|
|
147
|
-
```
|
|
161
|
+
### Requisitos Previos
|
|
148
162
|
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
Invoke-Expression (Invoke-WebRequest -Uri "https://raw.githubusercontent.com/charlesmu99/SpecCrew/main/scripts/install-qoder.ps1").Content
|
|
163
|
+
- Node.js >= 16.0.0
|
|
164
|
+
- IDEs compatibles: Qoder (predeterminado), Cursor, Claude Code
|
|
152
165
|
|
|
153
|
-
|
|
154
|
-
Invoke-Expression (Invoke-WebRequest -Uri "https://gitee.com/amutek/speccrew/raw/main/scripts/install-qoder.ps1").Content
|
|
155
|
-
```
|
|
156
|
-
|
|
157
|
-
> **Nota**: El script de instalación con un clic actualmente solo soporta Qoder IDE. Para otros IDEs (VS Code, Cursor, etc.), use el método de copia manual a continuación.
|
|
166
|
+
> **Nota**: Los adaptadores para Cursor y Claude Code aún no han sido probados en entornos IDE reales (implementados a nivel de código y verificados mediante pruebas E2E, pero aún no probados en Cursor/Claude Code real).
|
|
158
167
|
|
|
159
|
-
|
|
168
|
+
### 1. Instalar SpecCrew
|
|
160
169
|
|
|
161
170
|
```bash
|
|
162
|
-
|
|
163
|
-
git clone https://github.com/charlesmu99/SpecCrew.git
|
|
164
|
-
# o: git clone https://gitee.com/amutek/SpecCrew.git
|
|
165
|
-
|
|
166
|
-
# Copiar al proyecto destino (ajustar según el directorio de configuración de su IDE)
|
|
167
|
-
cp -r SpecCrew/.speccrew /path/to/your-project/
|
|
168
|
-
cp -r SpecCrew/SpecCrew-workspace /path/to/your-project/
|
|
169
|
-
|
|
170
|
-
# Para Qoder IDE, también copiar al directorio .qoder/
|
|
171
|
-
cp -r SpecCrew/.speccrew/agents/* /path/to/your-project/.qoder/agents/
|
|
172
|
-
cp -r SpecCrew/.speccrew/skills/* /path/to/your-project/.qoder/skills/
|
|
171
|
+
npm install -g speccrew
|
|
173
172
|
```
|
|
174
173
|
|
|
175
174
|
### 2. Inicializar Proyecto
|
|
176
175
|
|
|
176
|
+
Navegue al directorio raíz de su proyecto y ejecute el comando de inicialización:
|
|
177
|
+
|
|
177
178
|
```bash
|
|
178
|
-
|
|
179
|
-
# Ejecutado automáticamente por el Skill SpecCrew-project-init
|
|
180
|
-
```
|
|
179
|
+
cd /ruta/a/su-proyecto
|
|
181
180
|
|
|
182
|
-
|
|
181
|
+
# Predeterminado usa Qoder
|
|
182
|
+
speccrew init
|
|
183
183
|
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
# 4. Diseño Detallado
|
|
189
|
-
# 5. Implementación de Desarrollo
|
|
190
|
-
# 6. Pruebas
|
|
184
|
+
# O especificar IDE
|
|
185
|
+
speccrew init --ide qoder
|
|
186
|
+
speccrew init --ide cursor
|
|
187
|
+
speccrew init --ide claude
|
|
191
188
|
```
|
|
192
189
|
|
|
193
|
-
|
|
190
|
+
Después de la inicialización, se generarán en su proyecto:
|
|
191
|
+
- `.qoder/agents/` / `.cursor/agents/` / `.claude/agents/` — 7 definiciones de roles Agent
|
|
192
|
+
- `.qoder/skills/` / `.cursor/skills/` / `.claude/skills/` — 38 flujos de trabajo Skill
|
|
193
|
+
- `speccrew-workspace/` — Espacio de trabajo (directorios de iteración, base de conocimientos, plantillas de documentos)
|
|
194
|
+
- `.speccrewrc` — Archivo de configuración de SpecCrew
|
|
194
195
|
|
|
195
|
-
|
|
196
|
+
Para actualizar Agents y Skills para un IDE específico más tarde:
|
|
196
197
|
|
|
197
198
|
```bash
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
# macOS / Linux / WSL - Desinstalar desde Gitee (Espejo de China)
|
|
202
|
-
curl -fsSL https://gitee.com/amutek/speccrew/raw/main/scripts/uninstall-qoder.sh | bash
|
|
199
|
+
speccrew update --ide cursor
|
|
200
|
+
speccrew update --ide claude
|
|
203
201
|
```
|
|
204
202
|
|
|
205
|
-
|
|
206
|
-
# Windows - Desinstalar desde GitHub
|
|
207
|
-
Invoke-Expression (Invoke-WebRequest -Uri "https://raw.githubusercontent.com/charlesmu99/SpecCrew/main/scripts/uninstall-qoder.ps1").Content
|
|
208
|
-
|
|
209
|
-
# Windows - Desinstalar desde Gitee (Espejo de China)
|
|
210
|
-
Invoke-Expression (Invoke-WebRequest -Uri "https://gitee.com/amutek/speccrew/raw/main/scripts/uninstall-qoder.ps1").Content
|
|
211
|
-
```
|
|
203
|
+
### 3. Iniciar Flujo de Trabajo de Desarrollo
|
|
212
204
|
|
|
213
|
-
|
|
205
|
+
Siga el flujo de trabajo de ingeniería estándar paso a paso:
|
|
214
206
|
|
|
215
|
-
**
|
|
207
|
+
1. **PRD**: El Agent Product Manager analiza los requisitos y genera el documento de requisitos del producto
|
|
208
|
+
2. **Feature Design**: El Agent Feature Designer genera el documento de diseño de funcionalidades + contrato API
|
|
209
|
+
3. **System Design**: El Agent System Designer genera documentos de diseño del sistema por plataforma (frontend/backend/móvil/escritorio)
|
|
210
|
+
4. **Dev**: El Agent System Developer implementa el desarrollo por plataforma en paralelo
|
|
211
|
+
5. **System Test**: El Agent Test Manager coordina las pruebas de tres fases (diseño de casos → generación de código → reporte de ejecución)
|
|
212
|
+
6. **Archive**: Archivar iteración
|
|
216
213
|
|
|
217
|
-
|
|
218
|
-
# Eliminar directorio SpecCrew-workspace
|
|
219
|
-
rm -rf SpecCrew-workspace/
|
|
214
|
+
> Los entregables de cada fase requieren confirmación humana antes de proceder a la siguiente fase.
|
|
220
215
|
|
|
221
|
-
|
|
222
|
-
rm -rf .speccrew/agents/SpecCrew-*.md
|
|
223
|
-
rm -rf .speccrew/skills/SpecCrew-*/
|
|
216
|
+
### 4. Otros Comandos CLI
|
|
224
217
|
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
218
|
+
```bash
|
|
219
|
+
speccrew list # Listar agents y skills instalados
|
|
220
|
+
speccrew doctor # Diagnosticar entorno y estado de instalación
|
|
221
|
+
speccrew update # Actualizar agents y skills a la última versión
|
|
222
|
+
speccrew uninstall # Desinstalar SpecCrew (--all también elimina el workspace)
|
|
228
223
|
```
|
|
229
224
|
|
|
230
|
-
|
|
225
|
+
📖 **Guía Detallada**: Después de la instalación, consulta la [Guía de Inicio Rápido](docs/GETTING-STARTED.es.md) para el flujo de trabajo completo y la guía de conversación con agentes.
|
|
231
226
|
|
|
232
227
|
---
|
|
233
228
|
|
|
@@ -235,40 +230,51 @@ rm -rf .qoder/skills/SpecCrew-*/
|
|
|
235
230
|
|
|
236
231
|
```
|
|
237
232
|
your-project/
|
|
238
|
-
├── .
|
|
239
|
-
├──
|
|
240
|
-
│ ├──
|
|
241
|
-
│
|
|
233
|
+
├── .qoder/ # Directorio de configuración IDE (ejemplo Qoder)
|
|
234
|
+
│ ├── agents/ # 7 Agents de roles
|
|
235
|
+
│ │ ├── speccrew-team-leader.md # Líder de Equipo: Programación global y gestión de iteraciones
|
|
236
|
+
│ │ ├── speccrew-product-manager.md # Product Manager: Análisis de requisitos y PRD
|
|
237
|
+
│ │ ├── speccrew-feature-designer.md # Feature Designer: Feature Design + Contrato API
|
|
238
|
+
│ │ ├── speccrew-system-designer.md # System Designer: Diseño de sistema por plataforma
|
|
239
|
+
│ │ ├── speccrew-system-developer.md # System Developer: Desarrollo paralelo por plataforma
|
|
240
|
+
│ │ ├── speccrew-test-manager.md # Test Manager: Coordinación de pruebas de tres fases
|
|
241
|
+
│ │ └── speccrew-task-worker.md # Task Worker: Ejecución paralela de subtareas
|
|
242
|
+
│ └── skills/ # 38 Skills (agrupados por función)
|
|
243
|
+
│ ├── speccrew-pm-*/ # Gestión de Producto (análisis de requisitos, evaluación)
|
|
244
|
+
│ ├── speccrew-fd-*/ # Feature Design (Feature Design, Contrato API)
|
|
245
|
+
│ ├── speccrew-sd-*/ # System Design (frontend/backend/móvil/escritorio)
|
|
246
|
+
│ ├── speccrew-dev-*/ # Desarrollo (frontend/backend/móvil/escritorio)
|
|
247
|
+
│ ├── speccrew-test-*/ # Pruebas (diseño de casos/generación de código/reporte de ejecución)
|
|
248
|
+
│ ├── speccrew-knowledge-bizs-*/ # Conocimiento de Negocio (análisis API/análisis UI/clasificación de módulos, etc.)
|
|
249
|
+
│ ├── speccrew-knowledge-techs-*/ # Conocimiento Técnico (generación de stack/convenciones/índice, etc.)
|
|
250
|
+
│ ├── speccrew-knowledge-graph-*/ # Grafo de Conocimiento (leer/escribir/consultar)
|
|
251
|
+
│ └── speccrew-*/ # Utilidades (diagnósticos/marcas de tiempo/flujo de trabajo, etc.)
|
|
242
252
|
│
|
|
243
|
-
└──
|
|
253
|
+
└── speccrew-workspace/ # Espacio de trabajo (generado durante inicialización)
|
|
244
254
|
├── docs/ # Documentos administrativos
|
|
255
|
+
│ ├── configs/ # Archivos de configuración (mapeo de plataforma, mapeo de stack técnico, etc.)
|
|
245
256
|
│ ├── rules/ # Configuraciones de reglas
|
|
246
257
|
│ └── solutions/ # Documentos de soluciones
|
|
247
|
-
│ └── agent-knowledge-map.md
|
|
248
258
|
│
|
|
249
259
|
├── iterations/ # Proyectos de iteración (generados dinámicamente)
|
|
250
|
-
│ └── {número}-{tipo}-{nombre}/
|
|
260
|
+
│ └── {número}-{tipo}-{nombre}/
|
|
251
261
|
│ ├── 00.docs/ # Requisitos originales
|
|
252
262
|
│ ├── 01.product-requirement/ # Requisitos del producto
|
|
253
263
|
│ ├── 02.feature-design/ # Diseño de características
|
|
254
264
|
│ ├── 03.system-design/ # Diseño del sistema
|
|
255
265
|
│ ├── 04.development/ # Fase de desarrollo
|
|
256
|
-
│ ├── 05.test/
|
|
266
|
+
│ ├── 05.system-test/ # Pruebas del sistema
|
|
257
267
|
│ └── 06.delivery/ # Fase de entrega
|
|
258
268
|
│
|
|
259
269
|
├── iteration-archives/ # Archivos de iteración
|
|
260
|
-
│ └── {número}-{tipo}-{nombre}-{fecha}/
|
|
261
270
|
│
|
|
262
271
|
└── knowledges/ # Base de conocimiento
|
|
263
|
-
├── base/ #
|
|
272
|
+
├── base/ # Base/metadatos
|
|
264
273
|
│ ├── diagnosis-reports/ # Informes de diagnóstico
|
|
265
274
|
│ ├── sync-state/ # Estado de sincronización
|
|
266
275
|
│ └── tech-debts/ # Deudas técnicas
|
|
267
|
-
│
|
|
268
276
|
├── bizs/ # Conocimiento de negocio
|
|
269
|
-
│ └── {tipo-de-plataforma}/
|
|
270
|
-
│ └── {nombre-del-módulo}/
|
|
271
|
-
│
|
|
277
|
+
│ └── {tipo-de-plataforma}/{nombre-del-módulo}/
|
|
272
278
|
└── techs/ # Conocimiento técnico
|
|
273
279
|
└── {id-de-plataforma}/
|
|
274
280
|
```
|
|
@@ -304,9 +310,10 @@ your-project/
|
|
|
304
310
|
|
|
305
311
|
## Más Información
|
|
306
312
|
|
|
307
|
-
- **Mapa de Conocimiento del Agente**: [
|
|
308
|
-
- **
|
|
309
|
-
- **
|
|
313
|
+
- **Mapa de Conocimiento del Agente**: [speccrew-workspace/docs/agent-knowledge-map.md](./speccrew-workspace/docs/agent-knowledge-map.md)
|
|
314
|
+
- **npm**: https://www.npmjs.com/package/speccrew
|
|
315
|
+
- **GitHub**: https://github.com/charlesmu99/speccrew
|
|
316
|
+
- **Gitee**: https://gitee.com/amutek/speccrew
|
|
310
317
|
- **Qoder IDE**: https://qoder.com/
|
|
311
318
|
|
|
312
319
|
---
|