speccore 5.67.61 → 5.67.63
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.en.md +20 -15
- package/README.md +42 -38
- package/package.json +1 -1
package/README.en.md
CHANGED
|
@@ -7,19 +7,24 @@
|
|
|
7
7
|
```
|
|
8
8
|
init → doc2spec → analyze → split → plan → execute → pr → done
|
|
9
9
|
🚀Setup 📝Import 🧠Analyze 📦Split 📋Plan 💻Build 🔀PR ✅Archive
|
|
10
|
+
✅ CLI 🔒 AI 🔒 AI 🔒 AI 🔒 AI 🔒 AI 🔒 AI 🔒 AI
|
|
10
11
|
```
|
|
11
12
|
|
|
12
13
|
## 🚀 5 Minutes to First Task
|
|
13
14
|
|
|
14
15
|
```bash
|
|
16
|
+
# CLI usage (direct terminal commands)
|
|
15
17
|
npm install -g speccore
|
|
16
18
|
speccore init
|
|
17
|
-
speccore
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
19
|
+
speccore iteration create -n Q1 # Create iteration
|
|
20
|
+
|
|
21
|
+
# 🔒 AI usage (in WorkBuddy/Cursor/Trae via @spec-ask)
|
|
22
|
+
@spec-ask "import requirements.docx to Q1 iteration"
|
|
23
|
+
@spec-ask "analyze Q1 requirements and code health"
|
|
24
|
+
@spec-ask "split Q1 iteration into tasks"
|
|
25
|
+
@spec-ask "generate execution plan for Q1"
|
|
26
|
+
@spec-ask "execute Task-001 with AI"
|
|
27
|
+
@spec-ask "archive Task-001 after validation"
|
|
23
28
|
```
|
|
24
29
|
|
|
25
30
|
## 🎯 What do you want to do?
|
|
@@ -27,17 +32,17 @@ speccore done --task=Task-001 # Validate → archive
|
|
|
27
32
|
| I want to... | Command |
|
|
28
33
|
|:---|:---|
|
|
29
34
|
| **Start a new project** | `speccore init --interactive` |
|
|
30
|
-
| **Import a PRD document** |
|
|
31
|
-
| **Analyze requirements + code health** |
|
|
35
|
+
| **Import a PRD document** | `@spec-ask "import PRD.docx to Q1"` 🔒 |
|
|
36
|
+
| **Analyze requirements + code health** | `@spec-ask "analyze Q1 requirements"` 🔒 |
|
|
32
37
|
| **Split requirements into tasks** | `speccore iteration split -I Q1 --interactive` |
|
|
33
38
|
| **Fix a bug** | `speccore task new -n "Login timeout" --type=bugfix` |
|
|
34
39
|
| **Batch fix bugs** | `speccore task new --batch-file=bugs.xlsx --type=bugfix` |
|
|
35
40
|
| **Schedule overnight execution** | `speccore schedule create --at "02:00" --all -I Q1` |
|
|
36
|
-
| **AI auto-development** |
|
|
37
|
-
| **Create a Pull Request** |
|
|
38
|
-
| **Archive a completed task** |
|
|
39
|
-
| **Check project status** | `speccore` or `speccore
|
|
40
|
-
| **Natural language queries** |
|
|
41
|
+
| **AI auto-development** | `@spec-ask "execute Task-001"` 🔒 |
|
|
42
|
+
| **Create a Pull Request** | `@spec-ask "create PR for Task-001"` 🔒 |
|
|
43
|
+
| **Archive a completed task** | `@spec-ask "archive Task-001"` 🔒 |
|
|
44
|
+
| **Check project status** | `speccore` or `speccore dashboard` |
|
|
45
|
+
| **Natural language queries** | `@spec-ask "analyze current requirements"` 🔒 |
|
|
41
46
|
|
|
42
47
|
> 📋 Full command reference → [Command Reference](docs/commands.en.md) | 中文文档 → [README.zh.md](README.md)
|
|
43
48
|
|
|
@@ -53,9 +58,9 @@ speccore done --task=Task-001 # Validate → archive
|
|
|
53
58
|
|
|
54
59
|
```bash
|
|
55
60
|
speccore task new -n "Data migration" --schedule=night # Queue for night
|
|
56
|
-
speccore execute --all --scheduled # Run all queued
|
|
57
61
|
speccore schedule create --at "2026-08-10 02:00" --all -I Q1 # Exact time
|
|
58
|
-
speccore schedule daemon start
|
|
62
|
+
speccore schedule daemon start # Auto-execute on schedule
|
|
63
|
+
# 🔒 AI: @spec-ask "run all scheduled tasks"
|
|
59
64
|
```
|
|
60
65
|
|
|
61
66
|
## 📚 Documentation
|
package/README.md
CHANGED
|
@@ -39,7 +39,7 @@ speccore dashboard # 查
|
|
|
39
39
|
|
|
40
40
|
> 💡 **AI 命令**（在 WorkBuddy/Trae/Qcoder 中通过 `@spec-ask` 或 `/spec-ask` 使用）：分析需求、制定计划、执行开发。详见 [AGENTS.md](./AGENTS.md)。
|
|
41
41
|
|
|
42
|
-
## 核心流水线
|
|
42
|
+
## 核心流水线 🔒 AI 命令
|
|
43
43
|
|
|
44
44
|
```
|
|
45
45
|
init → doc2spec → analyze → split → plan → execute → pr → done → spec2doc
|
|
@@ -51,11 +51,13 @@ init → doc2spec → analyze → split → plan → execute → pr → done →
|
|
|
51
51
|
|
|
52
52
|
| 分类 | 命令 |
|
|
53
53
|
|------|------|
|
|
54
|
-
| 入口 | `
|
|
55
|
-
|
|
|
56
|
-
|
|
|
57
|
-
|
|
|
58
|
-
|
|
|
54
|
+
| CLI 入口 | `init` `welcome` `help` |
|
|
55
|
+
| CLI 管理 | `iteration` `task` `context` ✅ |
|
|
56
|
+
| CLI 查看 | `dashboard` `validate` `about` `config` `archive` |
|
|
57
|
+
| 🔒 AI 入口 | `ask` |
|
|
58
|
+
| 🔒 AI 流水线 | `doc2spec` `analyze` `split` `plan` `execute` `pr` `done` `spec2doc` |
|
|
59
|
+
| 🔒 AI 智能 | `dev` |
|
|
60
|
+
| 🔒 AI 变更 | `change` `retro` |
|
|
59
61
|
|
|
60
62
|
## 目录结构（全英文）
|
|
61
63
|
|
|
@@ -77,20 +79,22 @@ Iteration-001-meeting/
|
|
|
77
79
|
│ └── Task-001-*/ ← 含 .issues.md .needs-retry
|
|
78
80
|
```
|
|
79
81
|
|
|
80
|
-
## 断点重试
|
|
82
|
+
## 断点重试 🔒 AI 命令
|
|
81
83
|
|
|
82
84
|
```bash
|
|
83
|
-
|
|
85
|
+
# 在 AI IDE 中通过 @spec-ask 使用：
|
|
86
|
+
@spec-ask "全量执行" # 全量执行
|
|
84
87
|
# 部分任务失败 → 写入 .issues.md + .needs-retry
|
|
85
|
-
|
|
88
|
+
@spec-ask "断点续传" # 扫描 .needs-retry 续跑
|
|
86
89
|
```
|
|
87
90
|
|
|
88
|
-
## 批量回顾
|
|
91
|
+
## 批量回顾 🔒 AI 命令
|
|
89
92
|
|
|
90
93
|
```bash
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
+
# 在 AI IDE 中通过 @spec-ask 使用：
|
|
95
|
+
@spec-ask "生成所有任务的回顾"
|
|
96
|
+
@spec-ask "生成张三的所有任务回顾"
|
|
97
|
+
@spec-ask "生成所有 bugfix 类型任务的回顾"
|
|
94
98
|
```
|
|
95
99
|
|
|
96
100
|
### 🧠 AI 语义入口
|
|
@@ -110,7 +114,7 @@ speccore retro --all --type bugfix # 按类型
|
|
|
110
114
|
### 🔄 dev — 智能级联
|
|
111
115
|
在 AI IDE 中智能推进：`@spec-ask "全自动执行"`
|
|
112
116
|
|
|
113
|
-
### 🚀 全量流水线
|
|
117
|
+
### 🚀 全量流水线 🔒 AI 命令（在 IDE 中使用）
|
|
114
118
|
| 阶段 | 命令 | AI 模式 |
|
|
115
119
|
|------|------|------|
|
|
116
120
|
| 导入需求 | `doc2spec -f PRD.docx` | 📖 命令解释 |
|
|
@@ -132,26 +136,26 @@ speccore --version # v5.27.0
|
|
|
132
136
|
|
|
133
137
|
| 命令 | 别名 | 功能 |
|
|
134
138
|
|------|------|------|
|
|
135
|
-
| `ask` | — | 🧠 万能 AI 入口（4 模式） |
|
|
139
|
+
| `ask` | — | 🧠 🔒 万能 AI 入口（4 模式） |
|
|
136
140
|
| `welcome` | — | 🏷️ 项目名片 + 使用引导 |
|
|
137
141
|
| `dashboard` | `db` | 📊 期次/全局仪表盘 |
|
|
138
|
-
| `dev` | `d` | 🔄 智能级联流水线 |
|
|
142
|
+
| `dev` | `d` | 🔄 🔒 智能级联流水线 |
|
|
139
143
|
| `init` | `in` | 🏗️ 项目初始化 |
|
|
140
|
-
| `doc2spec` | `d2s` | 📝 PRD→SpecCore MD |
|
|
141
|
-
| `spec2doc` | `s2d` | 📤 SpecCore MD→Word/PDF/HTML |
|
|
142
|
-
| `analyze` | `al` | 🧠 AI 需求分析 |
|
|
143
|
-
| `split` | — | 📦 需求拆分 |
|
|
144
|
-
| `plan` | `pl` | 📐 执行计划 |
|
|
145
|
-
| `execute` | `ex` | ⚡ 执行开发 |
|
|
146
|
-
| `pr` | `mr` | 🔀 Pull Request |
|
|
147
|
-
| `done` | `dn` | ✅ 归档收尾 |
|
|
148
|
-
| `change` | `ch` | 🔄 需求变更 |
|
|
149
|
-
| `sync` | `sy` | 🔄 双向同步 |
|
|
144
|
+
| `doc2spec` | `d2s` | 📝 🔒 PRD→SpecCore MD |
|
|
145
|
+
| `spec2doc` | `s2d` | 📤 🔒 SpecCore MD→Word/PDF/HTML |
|
|
146
|
+
| `analyze` | `al` | 🧠 🔒 AI 需求分析 |
|
|
147
|
+
| `split` | — | 📦 🔒 需求拆分 |
|
|
148
|
+
| `plan` | `pl` | 📐 🔒 执行计划 |
|
|
149
|
+
| `execute` | `ex` | ⚡ 🔒 执行开发 |
|
|
150
|
+
| `pr` | `mr` | 🔀 🔒 Pull Request |
|
|
151
|
+
| `done` | `dn` | ✅ 🔒 归档收尾 |
|
|
152
|
+
| `change` | `ch` | 🔄 🔒 需求变更 |
|
|
153
|
+
| `sync` | `sy` | 🔄 🔒 双向同步 |
|
|
150
154
|
| `validate` | `vl` | ✅ 合规验证 |
|
|
151
|
-
| `track` | `trk` | 🔗 REQ→Task→Code 全链路 |
|
|
155
|
+
| `track` | `trk` | 🔗 🔒 REQ→Task→Code 全链路 |
|
|
152
156
|
| `search` | `sh` | 🔍 跨 Spec 全文搜索 |
|
|
153
|
-
| `retro` | `rt` | 📝 任务回顾复盘 + 评分 |
|
|
154
|
-
| `rename` | `rn` | ✏️ 重命名 |
|
|
157
|
+
| `retro` | `rt` | 📝 🔒 任务回顾复盘 + 评分 |
|
|
158
|
+
| `rename` | `rn` | ✏️ 🔒 重命名 |
|
|
155
159
|
| `ops` | `op` | 📜 操作历史 |
|
|
156
160
|
|
|
157
161
|
## TTY 智能适配
|
|
@@ -189,15 +193,15 @@ speccore --help full # 全量模式，含所有子命令和工具
|
|
|
189
193
|
|
|
190
194
|
| 文档 | 说明 |
|
|
191
195
|
|------|------|
|
|
192
|
-
| [快速开始](docs
|
|
193
|
-
| [命令参考](docs
|
|
194
|
-
| [总览](docs
|
|
195
|
-
| [场景实战](docs
|
|
196
|
-
| [SDD 方法论](docs/
|
|
197
|
-
| [工作空间组织](docs
|
|
198
|
-
| [工具适配说明](docs
|
|
199
|
-
| [三层加载机制](docs/
|
|
200
|
-
| [CI-CD 集成](docs/
|
|
196
|
+
| [快速开始](docs/quick-start.md) | 5 分钟上手，安装 → 完整流程 |
|
|
197
|
+
| [命令参考](docs/command-reference.md) | 全部 23 命令 + 子命令 + 示例 |
|
|
198
|
+
| [总览](docs/overview.md) | 核心概念 + 工作流 + 三种使用方式 |
|
|
199
|
+
| [场景实战](docs/scenarios.md) | 35 个真实开发场景 |
|
|
200
|
+
| [SDD 方法论](docs/sdd-methodology.md) | 规范驱动开发理念 |
|
|
201
|
+
| [工作空间组织](docs/workspace-organization.md) | 目录结构与文件规范 |
|
|
202
|
+
| [工具适配说明](docs/tool-adapters.md) | Qoder/TRAE 等 AI 工具集成 |
|
|
203
|
+
| [三层加载机制](docs/spec-layers.md) | GLOBAL/ITERATION/TASK 加载原理 |
|
|
204
|
+
| [CI-CD 集成](docs/ci-cd-spec-integration.md) | CI/CD 流水线 + Spec 注释 |
|
|
201
205
|
| [迁移指南](docs/migration-guide.md) | 从旧版本升级 |
|
|
202
206
|
| [CHANGELOG](CHANGELOG.md) | 版本历史 |
|
|
203
207
|
|