@jennie-shawn/starwork 0.1.0-alpha.0 → 0.1.0-alpha.10
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 +166 -13
- package/cli/README.md +22 -4
- package/cli/doctor-spec.md +83 -4
- package/cli/init-spec.md +48 -30
- package/cli/spawn-spec.md +4 -4
- package/cli/src/cli.js +2146 -93
- package/cli/test/init.test.js +566 -1
- package/cli/upgrade-spec.md +488 -0
- package/core/README.md +6 -0
- package/core/agent-lanes-spec.md +466 -0
- package/core/baseline/spec.md +1 -0
- package/core/capabilities/README.md +1 -0
- package/core/capabilities/agent-lanes/capability.md +34 -0
- package/core/capabilities/skill-mount/capability.md +13 -2
- package/core/core-v0.1-protocol.md +1 -0
- package/core/skill-management-spec.md +572 -0
- package/docs/README.md +3 -1
- package/docs/agent-install-guide.md +126 -0
- package/docs/alpha-test-guide.md +24 -13
- package/docs/cli-capabilities.html +70 -13
- package/docs/cli-skill-registry.html +752 -0
- package/docs/doctor-capabilities.html +631 -0
- package/docs/index.html +3 -1
- package/docs/product-direction.md +10 -6
- package/docs/roadmap.html +28 -14
- package/docs/roadmap.md +39 -8
- package/docs/v0.1-plan.md +15 -6
- package/package.json +3 -3
- package/skills/README.md +4 -0
- package/skills/neat-freak/SKILL.md +32 -0
- package/skills/neat-freak/agents/openai.yaml +2 -0
- package/skills/starworkDoctor/SKILL.md +355 -0
- package/skills/starworkDoctor/agents/openai.yaml +7 -0
- package/skills/starworkDoctor/references/hub-upgrade.md +73 -0
- package/skills/starworkDoctor/references/response-guide.md +57 -0
- package/skills/starworkDoctor-spec.md +764 -0
- package/skills/starworkInit/SKILL.md +45 -31
- package/skills/starworkInit-spec.md +59 -49
- package/skills/starworkMultiagent/SKILL.md +235 -0
- package/skills/starworkMultiagent/agents/openai.yaml +7 -0
- package/skills/starworkMultiagent-skill-plan.md +234 -0
- package/skills/starworkMultiagent-spec.md +265 -0
- package/skills/starworkSpawn/SKILL.md +3 -3
package/README.md
CHANGED
|
@@ -1,18 +1,171 @@
|
|
|
1
|
-
#
|
|
1
|
+
# StarWork
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
StarWork 是一套面向 AI Agent 的工作台协议和工具集,用来帮助用户把长期工作、跨会话协作、多项目管理和 Agent 工作流组织清楚。
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
它包含四个核心部分:
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
- **Core**:定义工作台应该长什么样,包括目录结构、角色边界、状态文件和健康检查规则。
|
|
8
|
+
- **CLI**:提供 `init`、`doctor`、`spawn`、`upgrade`、`adapt`、`pack install`、`multiagent` 等命令,用来创建、检查、升级、协作和扩展工作台。
|
|
9
|
+
- **Packs**:场景模板包。当前 A 测阶段默认使用通用 Pack。
|
|
10
|
+
- **Skills**:给 Codex 等 Agent 使用的工作流说明,让 Agent 能更可靠地帮用户设计和生成 StarWork 工作台。
|
|
8
11
|
|
|
9
|
-
|
|
12
|
+
当前版本处于 A 测阶段,适合测试安装流程、基础命令、工作台结构和 Agent skill 使用体验。
|
|
10
13
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
-
|
|
17
|
-
|
|
18
|
-
|
|
14
|
+
## 安装 CLI
|
|
15
|
+
|
|
16
|
+
全局安装:
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
npm install -g @jennie-shawn/starwork
|
|
20
|
+
starwork --version
|
|
21
|
+
starwork --help
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
不全局安装,直接运行:
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
npx @jennie-shawn/starwork --version
|
|
28
|
+
npx @jennie-shawn/starwork --help
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## 安装 Skills
|
|
32
|
+
|
|
33
|
+
StarWork skills 分两类管理:
|
|
34
|
+
|
|
35
|
+
- 系统 Skill 通过 GitHub 仓库和 `skills` CLI 安装到 Agent 全局环境。
|
|
36
|
+
- Kit 自带 Skill 跟着工作台走,例如 Hub Kit 自带 `starworkSpawn`,单项目 Kit 自带 `neat-freak`。
|
|
37
|
+
|
|
38
|
+
给 Codex 安装 StarWork 系统 Skill:
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
npx skills add jennie-shawn/starwork --skill starworkInit -g -a codex -y
|
|
42
|
+
npx skills add jennie-shawn/starwork --skill starworkDoctor -g -a codex -y
|
|
43
|
+
npx skills add jennie-shawn/starwork --skill starworkMultiagent -g -a codex -y
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
如果你只想先安装初始化助手:
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
npx skills add jennie-shawn/starwork --skill starworkInit -g -a codex -y
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
当前 skills:
|
|
53
|
+
|
|
54
|
+
- `starworkInit`:帮助 Agent 判断工作台类型、语言、是否需要事项,并生成友好的 `starwork init` 初始化方案。
|
|
55
|
+
- `starworkDoctor`:帮助 Agent 基于 `starwork doctor --json` 做目录逻辑诊断;用户明确要求升级时,也负责生成 `starwork upgrade --blueprint` 升级蓝图。
|
|
56
|
+
- `starworkMultiagent`:帮助 Agent 把“登记当前会话为常用智能体”“管理多 Agent 分工”“登记共享输出”等请求转换成 `starwork multiagent` 命令组合。
|
|
57
|
+
- `starworkSpawn`:Hub Kit 自带 Skill,帮助已有 Hub 设计 `starwork spawn --blueprint` 工作台定制单。
|
|
58
|
+
- `neat-freak`:单项目 Kit 自带 Skill,帮助项目收尾、整理和归档。
|
|
59
|
+
|
|
60
|
+
如果你希望让 Agent 帮你完成安装,可以把 [Agent 安装指南](docs/agent-install-guide.md) 里的提示词发给你的 Agent。
|
|
61
|
+
|
|
62
|
+
## 快速开始
|
|
63
|
+
|
|
64
|
+
创建一个单事务项目工作台:
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
starwork init \
|
|
68
|
+
--type single-light \
|
|
69
|
+
--pack general \
|
|
70
|
+
--language zh \
|
|
71
|
+
--name "StarWork A Test" \
|
|
72
|
+
--target ~/Desktop/starwork-a-test \
|
|
73
|
+
--yes
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
检查工作台:
|
|
77
|
+
|
|
78
|
+
```bash
|
|
79
|
+
starwork doctor --target ~/Desktop/starwork-a-test
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
创建一个多项目中枢:
|
|
83
|
+
|
|
84
|
+
```bash
|
|
85
|
+
starwork init \
|
|
86
|
+
--type hub \
|
|
87
|
+
--language zh \
|
|
88
|
+
--name "StarWork Hub A Test" \
|
|
89
|
+
--target ~/Desktop/starwork-hub-a-test \
|
|
90
|
+
--yes
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
从 Hub 生成一个项目:
|
|
94
|
+
|
|
95
|
+
```bash
|
|
96
|
+
starwork spawn \
|
|
97
|
+
--hub ~/Desktop/starwork-hub-a-test \
|
|
98
|
+
--name "Alpha Project" \
|
|
99
|
+
--target ~/Desktop/starwork-alpha-project \
|
|
100
|
+
--mode matter \
|
|
101
|
+
--yes
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
检查生成的项目:
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
starwork doctor --target ~/Desktop/starwork-alpha-project
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
## CLI 能力
|
|
111
|
+
|
|
112
|
+
```text
|
|
113
|
+
starwork init
|
|
114
|
+
starwork doctor
|
|
115
|
+
starwork spawn
|
|
116
|
+
starwork upgrade
|
|
117
|
+
starwork adapt
|
|
118
|
+
starwork pack install
|
|
119
|
+
starwork multiagent
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
当前能力:
|
|
123
|
+
|
|
124
|
+
- `init`:创建单事务项目、多事务项目或多项目 Hub;交互默认推荐单事务项目。
|
|
125
|
+
- `doctor`:检查工作台健康状态、必需文件、Pack 落地结果和 blueprint 定制结果。
|
|
126
|
+
- `spawn`:从已有 Hub 创建并登记卫星项目。
|
|
127
|
+
- `upgrade`:按 `starworkDoctor` skill 生成的升级蓝图,把历史模板安全升级为 StarWork 工作台。
|
|
128
|
+
- `adapt`:生成 Claude Code、Cursor 等 Agent 的适配文件。
|
|
129
|
+
- `pack install`:向兼容工作台安装支持的 Pack。
|
|
130
|
+
- `multiagent`:为同一项目建立自定义 Agent 职责位、绑定会话,并登记跨 lane 共享输出。
|
|
131
|
+
|
|
132
|
+
## 仓库结构
|
|
133
|
+
|
|
134
|
+
```text
|
|
135
|
+
.
|
|
136
|
+
├── core/ # StarWork Core 协议、Kit、Profile、Preset
|
|
137
|
+
├── cli/ # CLI 实现和命令规格
|
|
138
|
+
├── packs/ # 场景 Pack
|
|
139
|
+
├── skills/ # Agent skills
|
|
140
|
+
├── schemas/ # 结构化 schema
|
|
141
|
+
├── adapters/ # Agent 适配规则
|
|
142
|
+
├── examples/ # 示例
|
|
143
|
+
└── docs/ # 产品文档和 A 测指南
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
## A 测反馈重点
|
|
147
|
+
|
|
148
|
+
请优先反馈:
|
|
149
|
+
|
|
150
|
+
- CLI 是否能顺利安装和运行。
|
|
151
|
+
- `init` 创建的工作台结构是否容易理解。
|
|
152
|
+
- `doctor` 的检查结果是否能指导修复问题。
|
|
153
|
+
- Hub + Satellite 工作流是否自然。
|
|
154
|
+
- 系统 Skill 是否能被 Agent 正确识别和调用。
|
|
155
|
+
- Hub Kit 自带的 `starworkSpawn`、单项目 Kit 自带的 `neat-freak` 是否能在对应工作台内被正确发现。
|
|
156
|
+
|
|
157
|
+
更完整的测试脚本见 [A 测安装指南](docs/alpha-test-guide.md)。
|
|
158
|
+
|
|
159
|
+
## 开发
|
|
160
|
+
|
|
161
|
+
运行测试:
|
|
162
|
+
|
|
163
|
+
```bash
|
|
164
|
+
npm test
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
预览 npm 包内容:
|
|
168
|
+
|
|
169
|
+
```bash
|
|
170
|
+
npm pack --dry-run
|
|
171
|
+
```
|
package/cli/README.md
CHANGED
|
@@ -9,8 +9,10 @@ v0.1 只覆盖最小可用安装和适配能力:
|
|
|
9
9
|
- `starwork init`
|
|
10
10
|
- `starwork spawn`
|
|
11
11
|
- `starwork doctor`
|
|
12
|
+
- `starwork upgrade`
|
|
12
13
|
- `starwork adapt`
|
|
13
|
-
- `starwork pack install
|
|
14
|
+
- `starwork pack install`
|
|
15
|
+
- `starwork multiagent`
|
|
14
16
|
|
|
15
17
|
第一阶段重点:
|
|
16
18
|
|
|
@@ -18,16 +20,25 @@ v0.1 只覆盖最小可用安装和适配能力:
|
|
|
18
20
|
- 能从多项目中枢生成被管理的新项目工作台
|
|
19
21
|
- 能检查工作区结构是否完整
|
|
20
22
|
- 能生成或更新当前 Agent 所需适配文件
|
|
21
|
-
-
|
|
23
|
+
- 能为同一项目建立多 Agent 职责位、绑定会话并登记跨 lane 共享输出
|
|
24
|
+
- 能安装兼容 Pack,并在 A 测阶段优先验证通用工作与多项目中枢管理流程
|
|
22
25
|
- 安装和更新时不覆盖用户已有内容
|
|
23
26
|
|
|
24
27
|
当前 M2 CLI v0.1 最小闭环已落地:
|
|
25
28
|
|
|
26
|
-
- `starwork init`
|
|
29
|
+
- `starwork init` 第一版:可以初始化单事务项目、多事务项目和多项目管理中枢;交互模式默认推荐单事务项目,先确认工作台类型和语言;Hub 自动使用 `hub-management` Pack,单项目 v0.1 默认使用 `general` Pack,不主动推荐未定稿场景 Pack。
|
|
27
30
|
- `starwork spawn` 第一版:可以从健康 Hub 生成 `satellite-starter` / `satellite-matter` 项目工作台,支持 `--blueprint` 定制目录、路径、规则和 seed,并回写 Hub 项目注册表。
|
|
28
|
-
- `starwork doctor` 第一版:可以检查 workspace state、Core 必需角色、Kit 文件、正式事实源、业务工作区和 Pack 落地结果,并支持 `--json`
|
|
31
|
+
- `starwork doctor` 第一版:可以检查 workspace state、Core 必需角色、Kit 文件、正式事实源、业务工作区和 Pack 落地结果,并支持 `--json` 输出;alpha.4 开始可识别历史模板候选;alpha.5 开始输出目录 `inventory` 与语义 `signals`,供 `starworkDoctor` skill 判断。
|
|
32
|
+
- `starwork upgrade` 第一版:可以读取 `starworkDoctor` skill 生成的升级蓝图,把历史模板或非标准目录安全升级为 StarWork 工作台;v0.1 只支持 `--blueprint`,不自动判断升级方案。
|
|
29
33
|
- `starwork adapt` 第一版:可以为 Codex、Claude Code、Cursor、Trae 生成或登记轻量适配入口。
|
|
30
34
|
- `starwork pack install` 第一版:可以在健康工作台上补装 Pack,并更新路径、规则、模板和 workspace state。
|
|
35
|
+
- `starwork multiagent` 第一版:可以初始化 Agent Lanes、按项目自定义职责新增 lane、绑定 / 释放会话、查看状态,并登记跨 lane 可读输出。
|
|
36
|
+
- Skill 管理与分发第一版:Kit 可以自带 Skill,Hub 可以托管用户常用 Skill;`init` 写入 `.starwork/skills.json`,`spawn` 按 Hub registry 选择性分发 Skill,`doctor` 暴露 Skill manifest / registry / mount 事实。
|
|
37
|
+
|
|
38
|
+
后续规划:
|
|
39
|
+
|
|
40
|
+
- Pack 自带 Skill 与 upgrade blueprint actions:按 [`StarWork Skill 管理与分发机制 SPEC`](../core/skill-management-spec.md) 继续扩展。
|
|
41
|
+
- `starwork update`:面向已经是 StarWork 的工作台,处理未来 Core / Kit / Pack 版本迁移;与 `upgrade` 分开设计。
|
|
31
42
|
|
|
32
43
|
CLI 不在 v0.1 阶段处理账号、授权、消息平台 gateway 或复杂商业系统。
|
|
33
44
|
|
|
@@ -39,14 +50,21 @@ CLI 不在 v0.1 阶段处理账号、授权、消息平台 gateway 或复杂商
|
|
|
39
50
|
- [`starwork pack install` SPEC](./pack-install-spec.md)
|
|
40
51
|
- [`starwork spawn` SPEC](./spawn-spec.md)
|
|
41
52
|
- [`starwork spawn --blueprint` SPEC](./spawn-blueprint-spec.md)
|
|
53
|
+
- [`starwork upgrade` SPEC](./upgrade-spec.md)
|
|
54
|
+
- [`starwork multiagent` SPEC](../core/agent-lanes-spec.md)
|
|
42
55
|
|
|
43
56
|
## 本地运行
|
|
44
57
|
|
|
45
58
|
```bash
|
|
59
|
+
node cli/bin/starwork.js --version
|
|
60
|
+
node cli/bin/starwork.js --help
|
|
46
61
|
node cli/bin/starwork.js init --type single-light --pack general --dry-run
|
|
47
62
|
node cli/bin/starwork.js spawn --hub ./my-hub --name "新项目" --target ./new-project --mode matter --dry-run
|
|
48
63
|
node cli/bin/starwork.js spawn --hub ./my-hub --target ./new-project --blueprint ./blueprint.json --dry-run
|
|
64
|
+
node cli/bin/starwork.js upgrade --target ./old-workspace --blueprint ./upgrade-blueprint.json --dry-run
|
|
49
65
|
node cli/bin/starwork.js doctor --target ./my-workspace
|
|
66
|
+
node cli/bin/starwork.js multiagent init --lanes research,writing,review --target ./my-workspace --yes
|
|
67
|
+
node cli/bin/starwork.js multiagent bind research --session codex:manual-research-1 --target ./my-workspace --yes
|
|
50
68
|
node cli/bin/starwork.js adapt claude --target ./my-workspace --yes
|
|
51
69
|
node cli/bin/starwork.js pack install content-creator --target ./my-workspace --yes
|
|
52
70
|
```
|
package/cli/doctor-spec.md
CHANGED
|
@@ -6,8 +6,8 @@
|
|
|
6
6
|
- 所属模块:StarWork CLI
|
|
7
7
|
- 命令:`starwork doctor`
|
|
8
8
|
- 前置状态:Core v0.1 已封版,`starwork init` 第一版已落地
|
|
9
|
-
- 实现状态:v0.1
|
|
10
|
-
- 目标:检查一个 StarWork
|
|
9
|
+
- 实现状态:v0.1 最小实现已落地;历史模板升级诊断、目录 inventory 和 signals 已进入 alpha
|
|
10
|
+
- 目标:检查一个 StarWork 工作台是否健康,并把结构事实、风险和候选信号暴露出来;对历史模板用户只输出可供 AI 判断的诊断信号,不直接生成行动建议
|
|
11
11
|
|
|
12
12
|
## 一句话定义
|
|
13
13
|
|
|
@@ -15,6 +15,8 @@
|
|
|
15
15
|
|
|
16
16
|
它不负责创建工作台,不负责升级工作台,也不默认修复文件。它只做一件事:把 Core、Kit、Pack 和 Agent 适配文件之间的不一致检查出来,用人能看懂的方式报告。
|
|
17
17
|
|
|
18
|
+
从 alpha.4 起,`doctor` 还承担一个轻量探测入口职责:当目录不是标准 StarWork 工作台,但看起来像用户正在使用的历史模板时,它不会只说“不是工作台”,而是输出历史模板识别结果、目录 inventory 和 semantic signals,交给 `starworkDoctor` 做后续判断。
|
|
19
|
+
|
|
18
20
|
## 为什么先做 doctor
|
|
19
21
|
|
|
20
22
|
Core v0.1 已封版后,项目进入 M2:CLI v0.1 最小闭环。
|
|
@@ -90,6 +92,8 @@ starwork doctor --verbose
|
|
|
90
92
|
| `--json` | 输出机器可读 JSON。 |
|
|
91
93
|
| `--strict` | 将部分 warning 视为失败,适合测试和发布前检查。 |
|
|
92
94
|
| `--verbose` | 显示通过项、检查来源和路径解析细节。 |
|
|
95
|
+
| `--inventory-depth <number\|all>` | 控制目录结构探测深度,默认用于保护过大的工作区。 |
|
|
96
|
+
| `--inventory-limit <number>` | 控制最多输出多少个目录和文件条目。 |
|
|
93
97
|
| `--help` | 显示帮助。 |
|
|
94
98
|
|
|
95
99
|
v0.1 暂不提供 `--fix`。修复动作后续可以单独设计为 `starwork doctor --fix` 或 `starwork repair`,但第一版不要混入。
|
|
@@ -142,7 +146,7 @@ v0.1 暂不提供 `--fix`。修复动作后续可以单独设计为 `starwork do
|
|
|
142
146
|
结果:
|
|
143
147
|
|
|
144
148
|
- 找到:使用该目录作为工作区根目录。
|
|
145
|
-
- 未找到但当前目录有 StarWork
|
|
149
|
+
- 未找到但当前目录有 StarWork 或历史模板痕迹:报告缺少 workspace state,同时输出历史模板候选信号。
|
|
146
150
|
- 未找到且无 StarWork 痕迹:报告不是 StarWork 工作台。
|
|
147
151
|
|
|
148
152
|
v0.1 判断标准:
|
|
@@ -150,9 +154,42 @@ v0.1 判断标准:
|
|
|
150
154
|
| 情况 | 结果 |
|
|
151
155
|
|---|---|
|
|
152
156
|
| 找到 `.starwork/workspace.json` | 继续检查。 |
|
|
153
|
-
| 未找到 state,但有 `AGENTS.md` 和 `_系统/` / `_system/` | `fail`:缺少 workspace state
|
|
157
|
+
| 未找到 state,但有 `AGENTS.md` 和 `_系统/` / `_system/` | `fail`:缺少 workspace state,并输出候选信号。 |
|
|
158
|
+
| 未找到 state,但有 `references/outputs` 或 `参考资料/输出` | `fail`:识别为历史模板升级候选。 |
|
|
154
159
|
| 完全没有 StarWork 痕迹 | `fail`:不是 StarWork 工作台。 |
|
|
155
160
|
|
|
161
|
+
### Step 1.5:历史模板升级诊断
|
|
162
|
+
|
|
163
|
+
历史模板诊断只读文件结构,不移动、不复制、不写入任何文件。
|
|
164
|
+
|
|
165
|
+
识别信号:
|
|
166
|
+
|
|
167
|
+
| 信号 | 示例 |
|
|
168
|
+
|---|---|
|
|
169
|
+
| Agent 入口规则 | `AGENTS.md`、`CLAUDE.md`、`.cursorrules` |
|
|
170
|
+
| 系统目录 | `_系统/`、`_system/` |
|
|
171
|
+
| 事项目录 | `事项/`、`matters/` |
|
|
172
|
+
| 参考资料目录 | `参考资料/`、`资料/`、`素材/`、`references/`、`reference/` |
|
|
173
|
+
| 输出目录 | `输出/`、`成果/`、`outputs/`、`output/` |
|
|
174
|
+
| 身份和教训 | `identity/`、`lessons/`、`_系统/身份/`、`_system/identity/` |
|
|
175
|
+
|
|
176
|
+
推断规则:
|
|
177
|
+
|
|
178
|
+
| 推断项 | 规则 |
|
|
179
|
+
|---|---|
|
|
180
|
+
| `language` | 中文路径多则 `zh`,英文路径多则 `en`,不确定时默认为 `zh`。 |
|
|
181
|
+
| `workspace_type` | 存在 `事项/` 或 `matters/` 时推断为 `single-matter`,否则推断为 `single-light`。 |
|
|
182
|
+
输出内容:
|
|
183
|
+
|
|
184
|
+
- `upgrade.candidate: true`
|
|
185
|
+
- `upgrade.source: legacy-template`
|
|
186
|
+
- `upgrade.inferred.language`
|
|
187
|
+
- `upgrade.inferred.workspace_type`
|
|
188
|
+
- `upgrade.inferred.reasons`
|
|
189
|
+
- 检测到的参考资料目录和输出目录
|
|
190
|
+
|
|
191
|
+
注意:`doctor --json` 不输出 `next_steps`,也不输出 Pack 建议,避免影响 `starworkDoctor` 基于上下文做独立判断。正式升级仍由 `starworkDoctor` 生成 blueprint,再交给 `starwork upgrade --blueprint` 执行。
|
|
192
|
+
|
|
156
193
|
### Step 2:读取 workspace state
|
|
157
194
|
|
|
158
195
|
读取 `.starwork/workspace.json`。
|
|
@@ -388,6 +425,7 @@ Result:
|
|
|
388
425
|
"language": "zh",
|
|
389
426
|
"packs": ["content-creator"]
|
|
390
427
|
},
|
|
428
|
+
"upgrade": null,
|
|
391
429
|
"summary": {
|
|
392
430
|
"pass": 18,
|
|
393
431
|
"info": 1,
|
|
@@ -405,6 +443,41 @@ Result:
|
|
|
405
443
|
}
|
|
406
444
|
```
|
|
407
445
|
|
|
446
|
+
历史模板升级候选的 JSON 示例:
|
|
447
|
+
|
|
448
|
+
```json
|
|
449
|
+
{
|
|
450
|
+
"schema": "starwork.doctor.result.v0.1",
|
|
451
|
+
"ok": false,
|
|
452
|
+
"strict_ok": false,
|
|
453
|
+
"workspace_root": null,
|
|
454
|
+
"workspace": null,
|
|
455
|
+
"upgrade": {
|
|
456
|
+
"candidate": true,
|
|
457
|
+
"source": "legacy-template",
|
|
458
|
+
"confidence": "high",
|
|
459
|
+
"inferred": {
|
|
460
|
+
"language": "zh",
|
|
461
|
+
"workspace_type": "single-matter",
|
|
462
|
+
"references": ["参考资料"],
|
|
463
|
+
"outputs": ["输出"],
|
|
464
|
+
"reasons": {
|
|
465
|
+
"language": ["_系统 是中文工作区信号"],
|
|
466
|
+
"workspace_type": ["事项 表示存在事项或多事务推进结构"],
|
|
467
|
+
"references": ["参考资料 命中参考资料候选信号"],
|
|
468
|
+
"outputs": ["输出 命中成果或输出候选信号"]
|
|
469
|
+
}
|
|
470
|
+
}
|
|
471
|
+
},
|
|
472
|
+
"signals": {
|
|
473
|
+
"project_status_files": ["_系统/上下文/项目状态.md"],
|
|
474
|
+
"current_work_files": ["_系统/任务/当前工作.md"],
|
|
475
|
+
"readonly_candidate_dirs": ["参考资料"],
|
|
476
|
+
"writable_candidate_dirs": ["事项", "输出"]
|
|
477
|
+
}
|
|
478
|
+
}
|
|
479
|
+
```
|
|
480
|
+
|
|
408
481
|
## 检查 ID 命名
|
|
409
482
|
|
|
410
483
|
检查 ID 应稳定,方便测试、文档和后续自动化使用。
|
|
@@ -419,6 +492,7 @@ capability.*
|
|
|
419
492
|
pack.*
|
|
420
493
|
content.*
|
|
421
494
|
adapter.*
|
|
495
|
+
legacy.*
|
|
422
496
|
```
|
|
423
497
|
|
|
424
498
|
示例:
|
|
@@ -435,6 +509,9 @@ adapter.*
|
|
|
435
509
|
- `pack.paths.exist`
|
|
436
510
|
- `pack.templates.installed`
|
|
437
511
|
- `content.current_work.too_long`
|
|
512
|
+
- `legacy.template.detected`
|
|
513
|
+
- `legacy.references.detected`
|
|
514
|
+
- `legacy.outputs.detected`
|
|
438
515
|
|
|
439
516
|
## 与其他命令的关系
|
|
440
517
|
|
|
@@ -503,6 +580,8 @@ adapter.*
|
|
|
503
580
|
- 删除正式事实源目录后返回 fail。
|
|
504
581
|
- 删除 Pack seed 文件后返回 fail。
|
|
505
582
|
- 非 StarWork 目录返回 fail,并提示先运行 `starwork init`。
|
|
583
|
+
- 对存在 `references/outputs` 的英文历史模板返回 fail,但输出 `upgrade` 候选信号,不输出 `next_steps` 或 Pack 建议。
|
|
584
|
+
- 对存在 `参考资料/输出/事项` 的中文历史模板返回 fail,但推断为 `single-matter` + `zh`。
|
|
506
585
|
- `--json` 输出稳定结构。
|
|
507
586
|
- 没有 fail 时退出码为 `0`,有 fail 时退出码为 `1`。
|
|
508
587
|
|
package/cli/init-spec.md
CHANGED
|
@@ -104,48 +104,65 @@ v0.1 不在 `init` 中处理升级。
|
|
|
104
104
|
```text
|
|
105
105
|
你要建立哪种工作区?
|
|
106
106
|
|
|
107
|
-
1.
|
|
108
|
-
|
|
107
|
+
1. 单事务项目(推荐)
|
|
108
|
+
适合一个明确目标、一个阶段任务或一次成果交付。
|
|
109
109
|
|
|
110
|
-
2.
|
|
111
|
-
|
|
110
|
+
2. 多事务项目(进阶)
|
|
111
|
+
适合同一项目下有多个事项,需要推进、交接和复盘。
|
|
112
112
|
|
|
113
113
|
3. 多项目管理中枢
|
|
114
|
-
|
|
114
|
+
适合你有多个项目,希望统一管理身份、教训、知识、skills 和项目登记。
|
|
115
115
|
```
|
|
116
116
|
|
|
117
117
|
内部映射:
|
|
118
118
|
|
|
119
119
|
| 用户选择 | Kit / Preset | 说明 |
|
|
120
120
|
|---|---|---|
|
|
121
|
-
|
|
|
122
|
-
|
|
|
121
|
+
| 单事务项目 | `local-starter` | 默认推荐入口。不启用事项机制,使用轻量输入输出结构。 |
|
|
122
|
+
| 多事务项目 | `local-matter` | 进阶入口。启用 Matter Mode 和决策记录。 |
|
|
123
123
|
| 多项目管理中枢 | `hub` | 建立主库 / 中枢,不创建卫星项目。 |
|
|
124
124
|
|
|
125
125
|
注意:Core 中的 `satellite-matter` 更接近卫星项目 Kit,不应被 `init` 的“多项目管理中枢”入口直接使用。`init` 应使用独立的 Hub Kit / Hub Preset。
|
|
126
126
|
|
|
127
|
-
### Step 2
|
|
127
|
+
### Step 2:选择语言
|
|
128
128
|
|
|
129
|
-
|
|
129
|
+
CLI 应在交互模式下明确询问语言:
|
|
130
130
|
|
|
131
131
|
```text
|
|
132
|
-
|
|
132
|
+
第 2 步:工作台使用哪种语言?
|
|
133
133
|
|
|
134
|
-
1.
|
|
135
|
-
|
|
134
|
+
1. 中文(推荐)
|
|
135
|
+
目录、规则和 Pack 内容使用中文。
|
|
136
136
|
|
|
137
|
-
2.
|
|
138
|
-
|
|
137
|
+
2. English
|
|
138
|
+
Pack 内容使用英文;当前 Core Kit 仍以中文结构为主。
|
|
139
139
|
```
|
|
140
140
|
|
|
141
|
-
|
|
141
|
+
参数模式可通过 `--language zh|en` 指定。非交互和 `--yes` 默认使用 `zh`。
|
|
142
|
+
|
|
143
|
+
### Step 3:选择 Pack
|
|
144
|
+
|
|
145
|
+
v0.1 交互模式下不主动展示未定稿的场景 Pack。
|
|
146
|
+
|
|
147
|
+
```text
|
|
148
|
+
第 3 步:v0.1 单项目先使用通用工作 Pack(general)。
|
|
149
|
+
内容创作者等场景 Pack 还在定稿中,暂不在交互流程里主动推荐。
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
单项目默认使用:
|
|
142
153
|
|
|
143
|
-
|
|
|
154
|
+
| 工作区类型 | Pack | 说明 |
|
|
144
155
|
|---|---|---|
|
|
145
|
-
|
|
|
146
|
-
|
|
|
156
|
+
| 单事务项目 | `general` | 默认 Pack。不是“无 Pack”。 |
|
|
157
|
+
| 多事务项目 | `general` | 默认 Pack。不是“无 Pack”。 |
|
|
158
|
+
|
|
159
|
+
高级参数仍可显式传入兼容 Pack:
|
|
160
|
+
|
|
161
|
+
```bash
|
|
162
|
+
starwork init --type single-matter --pack content-creator
|
|
163
|
+
```
|
|
147
164
|
|
|
148
|
-
如果用户选择多项目管理中枢,不展示业务 Pack
|
|
165
|
+
如果用户选择多项目管理中枢,不展示业务 Pack 列表,也不询问场景 Pack。
|
|
149
166
|
|
|
150
167
|
多项目管理中枢应使用自己的管理 Pack:
|
|
151
168
|
|
|
@@ -153,12 +170,11 @@ v0.1 不在 `init` 中处理升级。
|
|
|
153
170
|
|---|---|---|
|
|
154
171
|
| 多项目管理中枢 | `hub-management` | 定义项目注册、共享身份、共享教训、知识库、skills 和跨项目联络。 |
|
|
155
172
|
|
|
156
|
-
### Step
|
|
173
|
+
### Step 4:确认基本信息
|
|
157
174
|
|
|
158
175
|
CLI 询问或自动推断:
|
|
159
176
|
|
|
160
177
|
- 工作台名称:默认使用当前目录名。
|
|
161
|
-
- 语言:v0.1 默认中文;高级参数可选择英文。
|
|
162
178
|
- 正式成果位置:默认由 Kit + Pack 合并后决定。
|
|
163
179
|
- 是否继续预览:默认是。
|
|
164
180
|
|
|
@@ -183,10 +199,10 @@ _系统/任务/当前工作.md
|
|
|
183
199
|
```text
|
|
184
200
|
将创建 StarWork 工作台:
|
|
185
201
|
|
|
186
|
-
|
|
187
|
-
Kit:local-
|
|
188
|
-
Pack:
|
|
189
|
-
工作台名称:my-
|
|
202
|
+
工作区类型:单事务项目
|
|
203
|
+
Kit:local-starter
|
|
204
|
+
Pack:general
|
|
205
|
+
工作台名称:my-workspace
|
|
190
206
|
|
|
191
207
|
将创建:
|
|
192
208
|
- AGENTS.md
|
|
@@ -305,10 +321,10 @@ Pack 可以改变业务流向,但不能移除工作区仪表盘。
|
|
|
305
321
|
{
|
|
306
322
|
"schema": "starwork.workspace.v0.1",
|
|
307
323
|
"core": "0.1",
|
|
308
|
-
"workspace_type": "single-
|
|
309
|
-
"kit": "local-
|
|
324
|
+
"workspace_type": "single-light",
|
|
325
|
+
"kit": "local-starter",
|
|
310
326
|
"packs": [
|
|
311
|
-
"
|
|
327
|
+
"general"
|
|
312
328
|
],
|
|
313
329
|
"language": "zh",
|
|
314
330
|
"formal_source": "由 pack 或用户选择决定",
|
|
@@ -335,6 +351,7 @@ starwork init --formal-source outputs/final
|
|
|
335
351
|
starwork init --target ./my-workspace
|
|
336
352
|
starwork init --dry-run
|
|
337
353
|
starwork init --yes
|
|
354
|
+
starwork init --language en
|
|
338
355
|
```
|
|
339
356
|
|
|
340
357
|
参数说明:
|
|
@@ -342,7 +359,8 @@ starwork init --yes
|
|
|
342
359
|
| 参数 | 说明 |
|
|
343
360
|
|---|---|
|
|
344
361
|
| `--type` | 工作区类型:`single-light`、`single-matter`、`hub`。 |
|
|
345
|
-
| `--pack` | Pack ID
|
|
362
|
+
| `--pack` | Pack ID;单项目交互默认 `general`,高级参数可传入兼容 Pack。 |
|
|
363
|
+
| `--language` | 工作台语言:`zh` 或 `en`;交互模式会询问,非交互默认 `zh`。 |
|
|
346
364
|
| `--name` | 工作台名称。 |
|
|
347
365
|
| `--formal-source` | 覆盖默认正式成果位置。 |
|
|
348
366
|
| `--target` | 指定初始化目标目录;默认是当前目录。 |
|
|
@@ -428,7 +446,7 @@ v0.1 `init` 不处理:
|
|
|
428
446
|
- 普通用户无需理解 Kit / Pack / preset,也能完成初始化。
|
|
429
447
|
- 用户能在写入前看懂将创建什么。
|
|
430
448
|
- 初始化不会静默覆盖已有内容。
|
|
431
|
-
-
|
|
449
|
+
- 单事务项目、多事务项目、多项目管理中枢三种入口边界清楚;默认推荐单事务项目,多事务项目作为进阶入口。
|
|
432
450
|
- 通用工作和自媒体内容创作都通过 Pack 表达。
|
|
433
451
|
- 多项目管理中枢不安装业务 Pack。
|
|
434
452
|
- 初始化结果可被 `starwork doctor` 检查。
|
package/cli/spawn-spec.md
CHANGED
|
@@ -27,8 +27,8 @@ Satellite / 具体执行项目
|
|
|
27
27
|
|
|
28
28
|
`init` 的职责是创建当前目录的工作台:
|
|
29
29
|
|
|
30
|
-
-
|
|
31
|
-
-
|
|
30
|
+
- 单事务项目
|
|
31
|
+
- 多事务项目
|
|
32
32
|
- 多项目管理中枢
|
|
33
33
|
|
|
34
34
|
但 `spawn` 涉及两个工作区:
|
|
@@ -70,7 +70,7 @@ starwork spawn \
|
|
|
70
70
|
```bash
|
|
71
71
|
starwork spawn --hub <hub-path> --name <project-name> --target <path>
|
|
72
72
|
starwork spawn --hub ~/my-hub --name "新项目" --target ~/projects/new-project --mode starter
|
|
73
|
-
starwork spawn --hub ~/my-hub --name "
|
|
73
|
+
starwork spawn --hub ~/my-hub --name "多阶段项目" --target ~/projects/multi-stage-project --mode matter
|
|
74
74
|
starwork spawn --hub ~/my-hub --target ~/projects/custom-project --blueprint ./blueprint.json --dry-run
|
|
75
75
|
starwork spawn --hub ~/my-hub --target ~/projects/custom-project --blueprint ./blueprint.json --yes
|
|
76
76
|
starwork spawn --hub ~/my-hub --name "新项目" --target ~/projects/new-project --dry-run
|
|
@@ -101,7 +101,7 @@ starwork spawn --hub ~/my-hub --name "新项目" --target ~/projects/new-project
|
|
|
101
101
|
|
|
102
102
|
v0.1 默认 `matter`。
|
|
103
103
|
|
|
104
|
-
|
|
104
|
+
原因:由 Hub 生成的卫星项目通常比单事务项目更复杂,往往需要事项追踪、跨会话接力和过程沉淀。
|
|
105
105
|
|
|
106
106
|
## 执行流程
|
|
107
107
|
|