speccore 5.67.60 → 5.67.62
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 +51 -43
- 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
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
🖥️ 规范驱动开发 CLI · 23 简洁命令(59 全量)· 人机协同闭环 · 多层 AI 架构
|
|
4
4
|
|
|
5
5
|
```bash
|
|
6
|
-
|
|
6
|
+
@spec-ask "我想做一个登录功能,计划晚8点分批执行"
|
|
7
7
|
```
|
|
8
8
|
|
|
9
9
|
---
|
|
@@ -11,7 +11,7 @@ speccore ask "我想做一个登录功能,计划晚8点分批执行"
|
|
|
11
11
|
## 架构概览
|
|
12
12
|
|
|
13
13
|
```
|
|
14
|
-
|
|
14
|
+
@spec-ask "..." ← AI 入口 → @spec-ask "全自动执行"
|
|
15
15
|
│ │
|
|
16
16
|
├─ 📖 命令解释 "dashboard 怎么用" ├─ 🏗️ 初始化
|
|
17
17
|
├─ 🗺️ 任务指引 "我想做登录" ├─ 📝 导入需求
|
|
@@ -30,13 +30,16 @@ speccore ask ←── AI 万能入口 ──→ speccore dev (智能级联)
|
|
|
30
30
|
|
|
31
31
|
```bash
|
|
32
32
|
npm install -g speccore
|
|
33
|
-
speccore init
|
|
34
|
-
speccore
|
|
35
|
-
speccore
|
|
36
|
-
speccore
|
|
33
|
+
speccore init # 初始化项目
|
|
34
|
+
speccore iteration create -n Q1 --topic my-project --owner luzhaosheng # 创建迭代
|
|
35
|
+
speccore task new -n "用户登录" --topic user-login -i my-project # 创建任务
|
|
36
|
+
speccore context --set --iteration Iteration-001-my-project # 切换上下文
|
|
37
|
+
speccore dashboard # 查看仪表盘
|
|
37
38
|
```
|
|
38
39
|
|
|
39
|
-
|
|
40
|
+
> 💡 **AI 命令**(在 WorkBuddy/Trae/Qcoder 中通过 `@spec-ask` 或 `/spec-ask` 使用):分析需求、制定计划、执行开发。详见 [AGENTS.md](./AGENTS.md)。
|
|
41
|
+
|
|
42
|
+
## 核心流水线 🔒 AI 命令
|
|
40
43
|
|
|
41
44
|
```
|
|
42
45
|
init → doc2spec → analyze → split → plan → execute → pr → done → spec2doc
|
|
@@ -48,11 +51,13 @@ init → doc2spec → analyze → split → plan → execute → pr → done →
|
|
|
48
51
|
|
|
49
52
|
| 分类 | 命令 |
|
|
50
53
|
|------|------|
|
|
51
|
-
| 入口 | `
|
|
52
|
-
|
|
|
53
|
-
|
|
|
54
|
-
|
|
|
55
|
-
|
|
|
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` |
|
|
56
61
|
|
|
57
62
|
## 目录结构(全英文)
|
|
58
63
|
|
|
@@ -74,28 +79,31 @@ Iteration-001-meeting/
|
|
|
74
79
|
│ └── Task-001-*/ ← 含 .issues.md .needs-retry
|
|
75
80
|
```
|
|
76
81
|
|
|
77
|
-
## 断点重试
|
|
82
|
+
## 断点重试 🔒 AI 命令
|
|
78
83
|
|
|
79
84
|
```bash
|
|
80
|
-
|
|
85
|
+
# 在 AI IDE 中通过 @spec-ask 使用:
|
|
86
|
+
@spec-ask "全量执行" # 全量执行
|
|
81
87
|
# 部分任务失败 → 写入 .issues.md + .needs-retry
|
|
82
|
-
|
|
88
|
+
@spec-ask "断点续传" # 扫描 .needs-retry 续跑
|
|
83
89
|
```
|
|
84
90
|
|
|
85
|
-
## 批量回顾
|
|
91
|
+
## 批量回顾 🔒 AI 命令
|
|
86
92
|
|
|
87
93
|
```bash
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
94
|
+
# 在 AI IDE 中通过 @spec-ask 使用:
|
|
95
|
+
@spec-ask "生成所有任务的回顾"
|
|
96
|
+
@spec-ask "生成张三的所有任务回顾"
|
|
97
|
+
@spec-ask "生成所有 bugfix 类型任务的回顾"
|
|
91
98
|
```
|
|
92
99
|
|
|
93
|
-
### 🧠
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
-
|
|
97
|
-
-
|
|
98
|
-
-
|
|
100
|
+
### 🧠 AI 语义入口
|
|
101
|
+
|
|
102
|
+
在 AI IDE 中使用 `@spec-ask` 或 `/spec-ask`,无需记忆命令:
|
|
103
|
+
- **📖 命令解释**:`@spec-ask "dashboard 怎么用"`
|
|
104
|
+
- **🗺️ 任务指引**:`@spec-ask "我想做一个支付功能"` → AI 自动编排全流程
|
|
105
|
+
- **🎯 意图匹配**:`@spec-ask "查看进度"` → AI 自动匹配 dashboard
|
|
106
|
+
- **⚡ 复杂编排**:`@spec-ask "分析+计划自动,执行前确认"` → analyze→plan 连续跑
|
|
99
107
|
|
|
100
108
|
### 📊 dashboard — 全局仪表盘
|
|
101
109
|
`speccore dashboard --scope global` 生成 Jira 标准 7 维度 HTML 看板:
|
|
@@ -104,9 +112,9 @@ speccore retro --all --type bugfix # 按类型
|
|
|
104
112
|
- 9 套主题、中英文切换、字体/字号调节、F 键全屏、四边脉冲扫描线
|
|
105
113
|
|
|
106
114
|
### 🔄 dev — 智能级联
|
|
107
|
-
|
|
115
|
+
在 AI IDE 中智能推进:`@spec-ask "全自动执行"`
|
|
108
116
|
|
|
109
|
-
### 🚀 全量流水线
|
|
117
|
+
### 🚀 全量流水线 🔒 AI 命令(在 IDE 中使用)
|
|
110
118
|
| 阶段 | 命令 | AI 模式 |
|
|
111
119
|
|------|------|------|
|
|
112
120
|
| 导入需求 | `doc2spec -f PRD.docx` | 📖 命令解释 |
|
|
@@ -128,26 +136,26 @@ speccore --version # v5.27.0
|
|
|
128
136
|
|
|
129
137
|
| 命令 | 别名 | 功能 |
|
|
130
138
|
|------|------|------|
|
|
131
|
-
| `ask` | — | 🧠 万能 AI 入口(4 模式) |
|
|
139
|
+
| `ask` | — | 🧠 🔒 万能 AI 入口(4 模式) |
|
|
132
140
|
| `welcome` | — | 🏷️ 项目名片 + 使用引导 |
|
|
133
141
|
| `dashboard` | `db` | 📊 期次/全局仪表盘 |
|
|
134
|
-
| `dev` | `d` | 🔄 智能级联流水线 |
|
|
142
|
+
| `dev` | `d` | 🔄 🔒 智能级联流水线 |
|
|
135
143
|
| `init` | `in` | 🏗️ 项目初始化 |
|
|
136
|
-
| `doc2spec` | `d2s` | 📝 PRD→SpecCore MD |
|
|
137
|
-
| `spec2doc` | `s2d` | 📤 SpecCore MD→Word/PDF/HTML |
|
|
138
|
-
| `analyze` | `al` | 🧠 AI 需求分析 |
|
|
139
|
-
| `split` | — | 📦 需求拆分 |
|
|
140
|
-
| `plan` | `pl` | 📐 执行计划 |
|
|
141
|
-
| `execute` | `ex` | ⚡ 执行开发 |
|
|
142
|
-
| `pr` | `mr` | 🔀 Pull Request |
|
|
143
|
-
| `done` | `dn` | ✅ 归档收尾 |
|
|
144
|
-
| `change` | `ch` | 🔄 需求变更 |
|
|
145
|
-
| `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` | 🔄 🔒 双向同步 |
|
|
146
154
|
| `validate` | `vl` | ✅ 合规验证 |
|
|
147
|
-
| `track` | `trk` | 🔗 REQ→Task→Code 全链路 |
|
|
155
|
+
| `track` | `trk` | 🔗 🔒 REQ→Task→Code 全链路 |
|
|
148
156
|
| `search` | `sh` | 🔍 跨 Spec 全文搜索 |
|
|
149
|
-
| `retro` | `rt` | 📝 任务回顾复盘 + 评分 |
|
|
150
|
-
| `rename` | `rn` | ✏️ 重命名 |
|
|
157
|
+
| `retro` | `rt` | 📝 🔒 任务回顾复盘 + 评分 |
|
|
158
|
+
| `rename` | `rn` | ✏️ 🔒 重命名 |
|
|
151
159
|
| `ops` | `op` | 📜 操作历史 |
|
|
152
160
|
|
|
153
161
|
## TTY 智能适配
|
|
@@ -159,7 +167,7 @@ speccore --version # v5.27.0
|
|
|
159
167
|
## 🤖 三层 AI 架构
|
|
160
168
|
|
|
161
169
|
```
|
|
162
|
-
|
|
170
|
+
@spec-ask "..." (AI IDE 入口)
|
|
163
171
|
├─ 🧠 自有 LLM → OpenAI / Ollama(SPECCORE_LLM_KEY 环境变量)
|
|
164
172
|
├─ 🤖 宿主 AI → WorkBuddy / TRAE / Qoder(自动检测)
|
|
165
173
|
└─ 📐 规则引擎 → 18 条命令 KB + 4 预定义工作流(永远可用)
|