@hongmaple0820/scale-engine 0.25.0 → 0.27.0

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.
Files changed (171) hide show
  1. package/LICENSE +15 -15
  2. package/README.en.md +384 -346
  3. package/README.md +564 -529
  4. package/dist/adapters/AiderAdapter.js +52 -52
  5. package/dist/adapters/AntigravityAdapter.d.ts +4 -0
  6. package/dist/adapters/AntigravityAdapter.js +21 -0
  7. package/dist/adapters/AntigravityAdapter.js.map +1 -0
  8. package/dist/adapters/ClaudeCodeAdapter.d.ts +4 -1
  9. package/dist/adapters/ClaudeCodeAdapter.js +34 -34
  10. package/dist/adapters/ClaudeCodeAdapter.js.map +1 -1
  11. package/dist/adapters/ClineAdapter.d.ts +4 -0
  12. package/dist/adapters/ClineAdapter.js +20 -0
  13. package/dist/adapters/ClineAdapter.js.map +1 -0
  14. package/dist/adapters/CodexAdapter.js +28 -28
  15. package/dist/adapters/CursorAdapter.js +26 -26
  16. package/dist/adapters/DeepSeekTuiAdapter.js +97 -97
  17. package/dist/adapters/DoubaoAdapter.js +33 -33
  18. package/dist/adapters/GeminiAdapter.js +26 -26
  19. package/dist/adapters/GenericProjectAgentAdapter.d.ts +29 -0
  20. package/dist/adapters/GenericProjectAgentAdapter.js +204 -0
  21. package/dist/adapters/GenericProjectAgentAdapter.js.map +1 -0
  22. package/dist/adapters/HermesAdapter.js +26 -26
  23. package/dist/adapters/JCodeAdapter.d.ts +4 -0
  24. package/dist/adapters/JCodeAdapter.js +19 -0
  25. package/dist/adapters/JCodeAdapter.js.map +1 -0
  26. package/dist/adapters/KiloCodeAdapter.d.ts +4 -0
  27. package/dist/adapters/KiloCodeAdapter.js +20 -0
  28. package/dist/adapters/KiloCodeAdapter.js.map +1 -0
  29. package/dist/adapters/KimiAdapter.js +32 -32
  30. package/dist/adapters/KiroAdapter.js +26 -26
  31. package/dist/adapters/OpenClawAdapter.js +26 -26
  32. package/dist/adapters/OpenCodeAdapter.js +26 -26
  33. package/dist/adapters/QCoderAdapter.js +26 -26
  34. package/dist/adapters/QoderAdapter.d.ts +4 -0
  35. package/dist/adapters/QoderAdapter.js +21 -0
  36. package/dist/adapters/QoderAdapter.js.map +1 -0
  37. package/dist/adapters/TraeAdapter.js +26 -26
  38. package/dist/adapters/VSCAdapter.js +26 -26
  39. package/dist/adapters/WindsurfAdapter.js +32 -32
  40. package/dist/adapters/WorkBuddyAdapter.js +26 -26
  41. package/dist/adapters/index.d.ts +5 -0
  42. package/dist/adapters/index.js +15 -0
  43. package/dist/adapters/index.js.map +1 -1
  44. package/dist/api/cli.js +190 -56
  45. package/dist/api/cli.js.map +1 -1
  46. package/dist/api/doctor.js +10 -3
  47. package/dist/api/doctor.js.map +1 -1
  48. package/dist/api/quickstart.js +7 -1
  49. package/dist/api/quickstart.js.map +1 -1
  50. package/dist/artifact/sqliteStore.js +89 -89
  51. package/dist/artifact/types.d.ts +1 -1
  52. package/dist/cli/phaseCommands.js +53 -53
  53. package/dist/cli/phaseCommands.js.map +1 -1
  54. package/dist/context/AntiPatternRegistry.js +20 -20
  55. package/dist/context/ContextBudget.d.ts +14 -0
  56. package/dist/context/ContextBudget.js +50 -14
  57. package/dist/context/ContextBudget.js.map +1 -1
  58. package/dist/context/ContextBuilder.js +155 -155
  59. package/dist/context/ContextCompiler.d.ts +34 -0
  60. package/dist/context/ContextCompiler.js +120 -0
  61. package/dist/context/ContextCompiler.js.map +1 -0
  62. package/dist/eval/WorkflowEval.js +4 -6
  63. package/dist/eval/WorkflowEval.js.map +1 -1
  64. package/dist/evolution/EvolutionEngine.js +31 -31
  65. package/dist/evolution/EvolutionEvaluator.d.ts +2 -0
  66. package/dist/evolution/EvolutionEvaluator.js +7 -1
  67. package/dist/evolution/EvolutionEvaluator.js.map +1 -1
  68. package/dist/fsm/FSMAgentBridge.js +11 -11
  69. package/dist/governance/GovernanceRoi.d.ts +6 -1
  70. package/dist/governance/GovernanceRoi.js +32 -0
  71. package/dist/governance/GovernanceRoi.js.map +1 -1
  72. package/dist/guardrails/DependencyAuditor.js +38 -0
  73. package/dist/guardrails/DependencyAuditor.js.map +1 -1
  74. package/dist/hooks/HookGeneratorEnhanced.js +218 -218
  75. package/dist/index.d.ts +2 -1
  76. package/dist/index.js +3 -2
  77. package/dist/index.js.map +1 -1
  78. package/dist/knowledge/SQLiteKnowledgeBase.js +28 -28
  79. package/dist/memory/MemoryBrain.js +52 -52
  80. package/dist/output/GovernanceDashboard.js +44 -44
  81. package/dist/output/HTMLArtifactLayer.js +31 -31
  82. package/dist/prompts/VibeTemplateGallery.js +121 -121
  83. package/dist/runtime/AiOsRuntime.d.ts +53 -0
  84. package/dist/runtime/AiOsRuntime.js +142 -0
  85. package/dist/runtime/AiOsRuntime.js.map +1 -0
  86. package/dist/runtime/index.d.ts +1 -0
  87. package/dist/runtime/index.js +1 -0
  88. package/dist/runtime/index.js.map +1 -1
  89. package/dist/skills/SkillDiscovery.js +12 -1
  90. package/dist/skills/SkillDiscovery.js.map +1 -1
  91. package/dist/skills/routing/SkillPlanner.js +128 -40
  92. package/dist/skills/routing/SkillPlanner.js.map +1 -1
  93. package/dist/skills/routing/SkillRoutingTypes.d.ts +17 -0
  94. package/dist/tools/SafeCommandRunner.d.ts +16 -0
  95. package/dist/tools/SafeCommandRunner.js +83 -0
  96. package/dist/tools/SafeCommandRunner.js.map +1 -0
  97. package/dist/workflow/EngineeringStandards.js +62 -62
  98. package/dist/workflow/GovernanceTemplatePacks.d.ts +1 -1
  99. package/dist/workflow/GovernanceTemplatePacks.js +1990 -162
  100. package/dist/workflow/GovernanceTemplatePacks.js.map +1 -1
  101. package/dist/workflow/GovernanceTemplates.d.ts +2 -0
  102. package/dist/workflow/GovernanceTemplates.js +1012 -1001
  103. package/dist/workflow/GovernanceTemplates.js.map +1 -1
  104. package/dist/workflow/ResourceGovernance.js +16 -16
  105. package/dist/workflow/TaskArtifactScaffolder.js +10 -10
  106. package/dist/workflow/UpgradeManager.d.ts +3 -2
  107. package/dist/workflow/UpgradeManager.js +134 -49
  108. package/dist/workflow/UpgradeManager.js.map +1 -1
  109. package/dist/workflow/WorkspaceTopology.js +18 -15
  110. package/dist/workflow/WorkspaceTopology.js.map +1 -1
  111. package/dist/workflow/gates/GateSystem.js +3 -9
  112. package/dist/workflow/gates/GateSystem.js.map +1 -1
  113. package/docs/ACTIVE_SECURITY_VISUAL_GATES.md +87 -87
  114. package/docs/AI_ENGINEERING_OS_POSITIONING.md +462 -0
  115. package/docs/BACKGROUND_HUNTER.md +62 -62
  116. package/docs/CODE_INTELLIGENCE.md +138 -138
  117. package/docs/CONTEXT_BUDGET.md +155 -113
  118. package/docs/DEPENDENCY_AUDIT.md +118 -89
  119. package/docs/EVOLUTION_SHADOW_MODE.md +63 -63
  120. package/docs/EXTERNAL_REFERENCES.md +63 -58
  121. package/docs/GITLAB_FLOW.md +125 -125
  122. package/docs/GOVERNANCE_DASHBOARD.md +85 -85
  123. package/docs/MEMORY_BRAIN.md +104 -104
  124. package/docs/MEMORY_FABRIC.md +136 -134
  125. package/docs/README.md +102 -92
  126. package/docs/RUNTIME_EVIDENCE.md +101 -101
  127. package/docs/SKILL-REPOSITORY.md +57 -57
  128. package/docs/SKILL_RADAR.md +135 -122
  129. package/docs/THIRD_PARTY_SKILLS.md +57 -57
  130. package/docs/WORKFLOW_EVAL.md +151 -151
  131. package/docs/guides/DEVELOPMENT_WORKFLOW.md +80 -0
  132. package/docs/guides/GETTING_STARTED.md +50 -0
  133. package/docs/start/README.md +78 -72
  134. package/docs/start/agent-governance-demo.md +107 -107
  135. package/docs/start/quickstart.md +137 -127
  136. package/docs/start/workflow-upgrade.md +32 -8
  137. package/docs/workflow/README.md +67 -0
  138. package/docs/workflow/node-library.md +52 -0
  139. package/docs/workflow/templates/api-contract.md +29 -0
  140. package/docs/workflow/templates/architecture-review.md +23 -0
  141. package/docs/workflow/templates/db-change-plan.md +20 -0
  142. package/docs/workflow/templates/docs-impact.md +17 -0
  143. package/docs/workflow/templates/e2e-plan.md +20 -0
  144. package/docs/workflow/templates/explore.md +16 -0
  145. package/docs/workflow/templates/github-actions-scale-preflight.yml +32 -0
  146. package/docs/workflow/templates/mini-prd.md +16 -0
  147. package/docs/workflow/templates/plan.md +37 -0
  148. package/docs/workflow/templates/pre-push-scale-preflight.sh +8 -0
  149. package/docs/workflow/templates/product-smoke.md +61 -0
  150. package/docs/workflow/templates/reality-check.md +28 -0
  151. package/docs/workflow/templates/resource-cleanup.md +17 -0
  152. package/docs/workflow/templates/resource-impact.md +25 -0
  153. package/docs/workflow/templates/review.md +12 -0
  154. package/docs/workflow/templates/runtime.md +23 -0
  155. package/docs/workflow/templates/security-review.md +26 -0
  156. package/docs/workflow/templates/skill-evidence.md +33 -0
  157. package/docs/workflow/templates/skill-plan.md +39 -0
  158. package/docs/workflow/templates/spec.md +17 -0
  159. package/docs/workflow/templates/standards-impact.md +28 -0
  160. package/docs/workflow/templates/summary.md +16 -0
  161. package/docs/workflow/templates/tasks.md +8 -0
  162. package/docs/workflow/templates/ui-spec.md +29 -0
  163. package/docs/workflow/templates/verification.md +20 -0
  164. package/docs/workflow/templates/visual-review.md +20 -0
  165. package/examples/demo-projects/agent-governance-demo/CONTEXT.md +14 -14
  166. package/examples/demo-projects/agent-governance-demo/README.md +48 -48
  167. package/examples/demo-projects/agent-governance-demo/docs/CONTEXT-MAP.md +14 -14
  168. package/examples/demo-projects/agent-governance-demo/package.json +22 -21
  169. package/examples/demo-projects/agent-governance-demo/src/oauth-state.ts +39 -39
  170. package/examples/demo-projects/agent-governance-demo/tests/oauth-state.test.ts +52 -52
  171. package/package.json +95 -78
@@ -1,72 +1,78 @@
1
- # SCALE Engine 入门路径
2
-
3
- 这个目录面向新用户。目标是先跑通一条最小路径,再理解完整体系,不要求一开始掌握所有命令。
4
-
5
- ## 推荐阅读顺序
6
-
7
- 1. [3 分钟快速开始](quickstart.md)
8
- 从空目录初始化治理工作流,看到 `.scale`、模板、验证 profile 和状态输出。
9
-
10
- 2. [Artifact 生命周期](artifact-lifecycle.md)
11
- 完整走一遍 Need → Spec → Plan → Task → Change → Evidence → Release,理解 FSM 和 Guard 如何用物理约束替代提示词建议。
12
-
13
- 3. [官方 Demo Walkthrough](agent-governance-demo.md)
14
- 用一个 OAuth state 加固任务演示:上下文对齐、诊断计划、TDD 切片、HTML artifact、资源治理和工程规范扫描。
15
-
16
- 4. 回到根目录 [README](../../README.md)
17
- 理解 SCALE Engine 的核心能力和 governance pack 选择。
18
-
19
- 4. [升级管理](../UPGRADE_MANAGEMENT.md)
20
- 理解工作流更新、第三方 skills/MCP/CLI 更新时如何先检查、生成计划、避免覆盖本地改动。
21
-
22
- 5. 查看 [文档地图](../README.md)
23
- 区分哪些文档是用户指南、哪些是参考资料、哪些是历史规划和过程记录。
24
-
25
- ## 15 分钟学习路径
26
-
27
- ```bash
28
- npm install -g @hongmaple0820/scale-engine
29
- scale --version
30
- mkdir scale-demo && cd scale-demo
31
- scale init --governance-pack standard
32
- scale preflight --preflight-profile quick
33
- scale status
34
- ```
35
-
36
- 跑完后先回答三个问题:
37
-
38
- - `.scale/verification.json` 里定义了哪些验证 profile
39
- - `docs/workflow/templates/` 里有哪些任务产物模板?
40
- - `scale status` 建议下一步做什么?
41
-
42
- 如果这三个问题答不上来,先不要继续看高级命令。
43
-
44
- ## 你应该先看到什么
45
-
46
- 跑完 quickstart 后,至少应该能看到:
47
-
48
- - `scale preflight --preflight-profile quick` 可以执行。
49
- - `scale status` 能告诉你当前项目下一步该做什么。
50
- - `.scale/verification.json` 存在,并描述本地验证 profile。
51
- - `docs/workflow/templates/` 存在,并包含 Mini-PRD、plan、verification、review、summary 等模板。
52
- - `scale artifact render` 可以把任务 Markdown 证据渲染成 HTML。
53
-
54
- 如果其中任何一步失败,先看命令输出,不要假设是环境问题。SCALE 的原则是:没有真实命令结果,就不声称通过。
55
-
56
- ## 场景选择
57
-
58
- | 场景 | 推荐入口 |
59
- | --- | --- |
60
- | 第一次试用 | [3 分钟快速开始](quickstart.md) |
61
- | 想看 Agent 治理闭环 | [官方 Demo Walkthrough](agent-governance-demo.md) |
62
- | 前端项目 | `scale init --governance-pack frontend-app` |
63
- | Node/TypeScript 包 | `scale init --governance-pack node-library` |
64
- | Go 多服务后端 | `scale init --governance-pack go-service-matrix` |
65
- | 多仓库/MOE 工作区 | `scale init --governance-pack moe-workspace` |
66
- | 文档、报告、截图、脚本混乱 | `scale init --governance-pack resource-governance` |
67
- | 工作流或第三方能力要升级 | `scale upgrade check && scale upgrade plan --html` |
68
-
69
-
70
- ## 工作流升级短路径
71
-
72
- 已有项目先看 [SCALE workflow upgrade guide](workflow-upgrade.md)。它说明 `scale init --interactive`、`scale upgrade check/plan/apply/rollback`、仓库本地 `make workflow-upgrade-*` 入口,以及生成文件更新和项目级验证之间的边界。
1
+ # SCALE Engine 入门路径
2
+
3
+ 这个目录面向新用户。目标是先跑通一条最小路径,再理解完整体系,不要求一开始掌握所有命令。
4
+
5
+ ## 推荐阅读顺序
6
+
7
+ 1. [3 分钟快速开始](quickstart.md)
8
+ 从空目录初始化治理工作流,看到 `.scale`、模板、验证 profile 和状态输出。
9
+
10
+ 2. [Artifact 生命周期](artifact-lifecycle.md)
11
+ 完整走一遍 Need → Spec → Plan → Task → Change → Evidence → Release,理解 FSM 和 Guard 如何用物理约束替代提示词建议。
12
+
13
+ 3. [官方 Demo Walkthrough](agent-governance-demo.md)
14
+ 用一个 OAuth state 加固任务演示:上下文对齐、诊断计划、TDD 切片、HTML artifact、资源治理和工程规范扫描。
15
+
16
+ 4. 回到根目录 [README](../../README.md)
17
+ 理解 SCALE Engine 的核心能力和 governance pack 选择。
18
+
19
+ 4. [工作流升级指南](workflow-upgrade.md)
20
+ 理解工作流更新、第三方 skills/MCP/CLI 更新时如何先检查、生成计划、自动刷新干净受管文件,并避免覆盖本地改动。
21
+
22
+ 5. 查看 [文档地图](../README.md)
23
+ 区分哪些文档是用户指南、哪些是参考资料、哪些是历史规划和过程记录。
24
+
25
+ 如果你要开发的是 `scale-engine` 仓库本身,而不是把 SCALE 接入别的项目,改看:
26
+
27
+ - [../guides/GETTING_STARTED.md](../guides/GETTING_STARTED.md)
28
+ - [../guides/DEVELOPMENT_WORKFLOW.md](../guides/DEVELOPMENT_WORKFLOW.md)
29
+ - [../workflow/README.md](../workflow/README.md)
30
+
31
+ ## 15 分钟学习路径
32
+
33
+ ```bash
34
+ npm install -g @hongmaple0820/scale-engine
35
+ scale --version
36
+ mkdir scale-demo && cd scale-demo
37
+ scale init --governance-pack standard
38
+ scale preflight --preflight-profile quick
39
+ scale status
40
+ ```
41
+
42
+ 跑完后先回答三个问题:
43
+
44
+ - `.scale/verification.json` 里定义了哪些验证 profile?
45
+ - `docs/workflow/templates/` 里有哪些任务产物模板?
46
+ - `scale status` 建议下一步做什么?
47
+
48
+ 如果这三个问题答不上来,先不要继续看高级命令。
49
+
50
+ ## 你应该先看到什么
51
+
52
+ 跑完 quickstart 后,至少应该能看到:
53
+
54
+ - `scale preflight --preflight-profile quick` 可以执行。
55
+ - `scale status` 能告诉你当前项目下一步该做什么。
56
+ - `.scale/verification.json` 存在,并描述本地验证 profile。
57
+ - `docs/workflow/templates/` 存在,并包含 Mini-PRD、plan、verification、review、summary 等模板。
58
+ - `scale artifact render` 可以把任务 Markdown 证据渲染成 HTML。
59
+
60
+ 如果其中任何一步失败,先看命令输出,不要假设是环境问题。SCALE 的原则是:没有真实命令结果,就不声称通过。
61
+
62
+ ## 场景选择
63
+
64
+ | 场景 | 推荐入口 |
65
+ | --- | --- |
66
+ | 第一次试用 | [3 分钟快速开始](quickstart.md) |
67
+ | 想看 Agent 治理闭环 | [官方 Demo Walkthrough](agent-governance-demo.md) |
68
+ | 前端项目 | `scale init --governance-pack frontend-app` |
69
+ | Node/TypeScript 包 | `scale init --governance-pack node-library` |
70
+ | Go 多服务后端 | `scale init --governance-pack go-service-matrix` |
71
+ | 多仓库/MOE 工作区 | `scale init --governance-pack moe-workspace` |
72
+ | 文档、报告、截图、脚本混乱 | `scale init --governance-pack resource-governance` |
73
+ | 工作流或第三方能力要升级 | `scale upgrade check --lang zh && scale upgrade plan --html --lang zh` |
74
+
75
+
76
+ ## 工作流升级短路径
77
+
78
+ 已有项目先看 [SCALE 工作流升级指南](workflow-upgrade.md)。它说明 `scale init --interactive`、`scale upgrade check/plan/apply/rollback`、`--lang zh/en` 双语输出、仓库本地 `make workflow-upgrade-*` 入口,以及生成文件更新和项目级验证之间的边界。
@@ -1,107 +1,107 @@
1
- # 官方 Demo Walkthrough:让 Agent 不再跳过工程纪律
2
-
3
- 这个 demo 用一个很小的 OAuth state 校验任务,演示 SCALE 如何把“应该做”的工程动作变成可检查证据。
4
-
5
- ## Demo 目标
6
-
7
- 我们要实现并验证一个安全敏感行为:
8
-
9
- > 当 OAuth callback 的 state 过期、被消费或不匹配时,系统必须拒绝请求,而不是返回模糊 500。
10
-
11
- SCALE 关注的不是这段业务逻辑有多复杂,而是 Agent 是否:
12
-
13
- - 先澄清上下文和验收标准。
14
- - 先诊断失败模式,不盲修。
15
- - 写出可检查的 TDD 切片。
16
- - 运行验证命令并留下证据。
17
- - 生成可评审的 Markdown 和 HTML artifact。
18
- - 不把临时报告、截图、脚本、敏感信息乱提交。
19
-
20
- ## 1. 准备 demo 项目
21
-
22
- 从仓库复制官方 demo:
23
-
24
- ```powershell
25
- Copy-Item -Recurse E:\project\scale-engine\examples\demo-projects\agent-governance-demo .\scale-agent-demo
26
- Set-Location .\scale-agent-demo
27
- npm install
28
- npm test
29
- ```
30
-
31
- macOS/Linux 可以用:
32
-
33
- ```bash
34
- cp -R /path/to/scale-engine/examples/demo-projects/agent-governance-demo ./scale-agent-demo
35
- cd scale-agent-demo
36
- npm install
37
- npm test
38
- ```
39
-
40
- ## 2. 安装治理工作流
41
-
42
- ```bash
43
- scale init --governance-pack node-library
44
- scale preflight --preflight-profile quick
45
- scale status
46
- ```
47
-
48
- 你应该看到 SCALE 生成 `.scale`、`docs/workflow/templates` 和项目治理规则。
49
-
50
- ## 3. 建立任务证据
51
-
52
- ```bash
53
- scale context init --name "Agent Governance Demo"
54
- scale runtime start --session-id 2026-05-18-oauth-state --task-id 2026-05-18-oauth-state --level M --agent codex
55
- scale context grill --task-id 2026-05-18-oauth-state --task "加固 OAuth state 校验"
56
- scale diagnose plan --task-id 2026-05-18-oauth-state --symptom "OAuth callback 在 state 过期或不匹配时行为不明确"
57
- scale tdd slice --task-id 2026-05-18-oauth-state --behavior "拒绝过期、已消费或不匹配的 OAuth state" --public-interface "verifyOAuthState(record, providedState, now)" --failing-test "expired, consumed, mismatched state should return ok=false" --test-file tests/oauth-state.test.ts --impl-files src/oauth-state.ts
58
- ```
59
-
60
- 这一步会在任务目录中沉淀探索、诊断和 TDD 证据。
61
-
62
- ## 4. 运行真实验证
63
-
64
- ```bash
65
- npm test
66
- scale standards scan --dir .
67
- scale assets scan --dir .
68
- scale runtime record --title "demo business tests" --kind command --status passed --command "npm test" --exit-code 0 --summary "official demo OAuth state tests passed"
69
- scale runtime final-check --task-id 2026-05-18-oauth-state --session-id 2026-05-18-oauth-state --level M
70
- ```
71
-
72
- 验收标准:
73
-
74
- - `npm test` 必须真实通过。
75
- - `standards scan` 不能发现阻断级别问题。
76
- - `assets scan` 应能识别长期维护文档、任务证据和生成产物分类。
77
- - `runtime final-check` 必须确认当前任务范围内有通过证据,且没有失败证据。
78
-
79
- ## 5. 生成记忆候选和 HTML artifact
80
-
81
- ```bash
82
- scale memory pack --task-id 2026-05-18-oauth-state --session-id 2026-05-18-oauth-state --task "加固 OAuth state 校验" --level M --budget 4000
83
- scale memory settle --task-id 2026-05-18-oauth-state --session-id 2026-05-18-oauth-state --task "加固 OAuth state 校验" --level M
84
- ```
85
-
86
- `memory pack` 用于恢复上下文,`memory settle` 用于把本次真实验证沉淀成可审查学习候选。候选仍需要人审后才能进入长期知识库或工程规范。
87
-
88
- ```bash
89
- scale artifact render --task-id 2026-05-18-oauth-state --artifact-dir docs/worklog/tasks/2026-05-18-oauth-state
90
- scale artifact doctor --artifact-dir docs/worklog/tasks/2026-05-18-oauth-state
91
- scale artifact open --task-id 2026-05-18-oauth-state --artifact-dir docs/worklog/tasks/2026-05-18-oauth-state
92
- ```
93
-
94
- HTML artifact 的价值是让人类更快评审 Agent 的思考、证据和风险。Markdown 仍然是源文件,HTML 是交付视图。
95
-
96
- ## 6. 对比没有 SCALE 的情况
97
-
98
- 没有 SCALE 时,Agent 很容易出现这些行为:
99
-
100
- - 直接改实现,不先说明验收标准。
101
- - 修了 happy path,却漏掉过期、已消费、不匹配等异常路径。
102
- - 说“测试通过”,但没有命令输出。
103
- - 写了临时脚本、截图、报告,却不知道哪些应该提交。
104
- - 发版前没有 review evidence 和风险记录。
105
-
106
- 有 SCALE 后,这些行为会被命令、模板、门禁和证据文件显式化。它不能替代人类判断,但能让 Agent 的工作不再靠口头保证。
107
-
1
+ # 官方 Demo Walkthrough:让 Agent 不再跳过工程纪律
2
+
3
+ 这个 demo 用一个很小的 OAuth state 校验任务,演示 SCALE 如何把“应该做”的工程动作变成可检查证据。
4
+
5
+ ## Demo 目标
6
+
7
+ 我们要实现并验证一个安全敏感行为:
8
+
9
+ > 当 OAuth callback 的 state 过期、被消费或不匹配时,系统必须拒绝请求,而不是返回模糊 500。
10
+
11
+ SCALE 关注的不是这段业务逻辑有多复杂,而是 Agent 是否:
12
+
13
+ - 先澄清上下文和验收标准。
14
+ - 先诊断失败模式,不盲修。
15
+ - 写出可检查的 TDD 切片。
16
+ - 运行验证命令并留下证据。
17
+ - 生成可评审的 Markdown 和 HTML artifact。
18
+ - 不把临时报告、截图、脚本、敏感信息乱提交。
19
+
20
+ ## 1. 准备 demo 项目
21
+
22
+ 从仓库复制官方 demo:
23
+
24
+ ```powershell
25
+ Copy-Item -Recurse E:\project\scale-engine\examples\demo-projects\agent-governance-demo .\scale-agent-demo
26
+ Set-Location .\scale-agent-demo
27
+ npm install
28
+ npm test
29
+ ```
30
+
31
+ macOS/Linux 可以用:
32
+
33
+ ```bash
34
+ cp -R /path/to/scale-engine/examples/demo-projects/agent-governance-demo ./scale-agent-demo
35
+ cd scale-agent-demo
36
+ npm install
37
+ npm test
38
+ ```
39
+
40
+ ## 2. 安装治理工作流
41
+
42
+ ```bash
43
+ scale init --governance-pack node-library
44
+ scale preflight --preflight-profile quick
45
+ scale status
46
+ ```
47
+
48
+ 你应该看到 SCALE 生成 `.scale`、`docs/workflow/templates` 和项目治理规则。
49
+
50
+ ## 3. 建立任务证据
51
+
52
+ ```bash
53
+ scale context init --name "Agent Governance Demo"
54
+ scale runtime start --session-id 2026-05-18-oauth-state --task-id 2026-05-18-oauth-state --level M --agent codex
55
+ scale context grill --task-id 2026-05-18-oauth-state --task "加固 OAuth state 校验"
56
+ scale diagnose plan --task-id 2026-05-18-oauth-state --symptom "OAuth callback 在 state 过期或不匹配时行为不明确"
57
+ scale tdd slice --task-id 2026-05-18-oauth-state --behavior "拒绝过期、已消费或不匹配的 OAuth state" --public-interface "verifyOAuthState(record, providedState, now)" --failing-test "expired, consumed, mismatched state should return ok=false" --test-file tests/oauth-state.test.ts --impl-files src/oauth-state.ts
58
+ ```
59
+
60
+ 这一步会在任务目录中沉淀探索、诊断和 TDD 证据。
61
+
62
+ ## 4. 运行真实验证
63
+
64
+ ```bash
65
+ npm test
66
+ scale standards scan --dir .
67
+ scale assets scan --dir .
68
+ scale runtime record --title "demo business tests" --kind command --status passed --command "npm test" --exit-code 0 --summary "official demo OAuth state tests passed"
69
+ scale runtime final-check --task-id 2026-05-18-oauth-state --session-id 2026-05-18-oauth-state --level M
70
+ ```
71
+
72
+ 验收标准:
73
+
74
+ - `npm test` 必须真实通过。
75
+ - `standards scan` 不能发现阻断级别问题。
76
+ - `assets scan` 应能识别长期维护文档、任务证据和生成产物分类。
77
+ - `runtime final-check` 必须确认当前任务范围内有通过证据,且没有失败证据。
78
+
79
+ ## 5. 生成记忆候选和 HTML artifact
80
+
81
+ ```bash
82
+ scale memory pack --task-id 2026-05-18-oauth-state --session-id 2026-05-18-oauth-state --task "加固 OAuth state 校验" --level M --budget 4000
83
+ scale memory settle --task-id 2026-05-18-oauth-state --session-id 2026-05-18-oauth-state --task "加固 OAuth state 校验" --level M
84
+ ```
85
+
86
+ `memory pack` 用于恢复上下文,`memory settle` 用于把本次真实验证沉淀成可审查学习候选。候选仍需要人审后才能进入长期知识库或工程规范。
87
+
88
+ ```bash
89
+ scale artifact render --task-id 2026-05-18-oauth-state --artifact-dir docs/worklog/tasks/2026-05-18-oauth-state
90
+ scale artifact doctor --artifact-dir docs/worklog/tasks/2026-05-18-oauth-state
91
+ scale artifact open --task-id 2026-05-18-oauth-state --artifact-dir docs/worklog/tasks/2026-05-18-oauth-state
92
+ ```
93
+
94
+ HTML artifact 的价值是让人类更快评审 Agent 的思考、证据和风险。Markdown 仍然是源文件,HTML 是交付视图。
95
+
96
+ ## 6. 对比没有 SCALE 的情况
97
+
98
+ 没有 SCALE 时,Agent 很容易出现这些行为:
99
+
100
+ - 直接改实现,不先说明验收标准。
101
+ - 修了 happy path,却漏掉过期、已消费、不匹配等异常路径。
102
+ - 说“测试通过”,但没有命令输出。
103
+ - 写了临时脚本、截图、报告,却不知道哪些应该提交。
104
+ - 发版前没有 review evidence 和风险记录。
105
+
106
+ 有 SCALE 后,这些行为会被命令、模板、门禁和证据文件显式化。它不能替代人类判断,但能让 Agent 的工作不再靠口头保证。
107
+
@@ -1,127 +1,137 @@
1
- # 3 分钟快速开始
2
-
3
- 目标:在一个空目录中安装 SCALE 治理工作流,并看到可验证的项目产物。
4
-
5
- ## 前置条件
6
-
7
- - Node.js 20 或更高版本。
8
- - 已安装 npm。
9
- - Windows PowerShell、Git Bash、macOS/Linux shell 都可以执行。
10
-
11
- ## 1. 安装 CLI
12
-
13
- ```bash
14
- npm install -g @hongmaple0820/scale-engine
15
- scale --version
16
- ```
17
-
18
- 如果你在开发 `scale-engine` 本仓库,也可以用本地构建后的命令:
19
-
20
- ```bash
21
- node E:/project/scale-engine/dist/api/cli.js --help
22
- ```
23
-
24
- ## 2. 初始化一个空项目
25
-
26
- ```bash
27
- mkdir scale-demo
28
- cd scale-demo
29
- scale init --governance-pack standard
30
- ```
31
-
32
- 这一步会生成:
33
-
34
- ```text
35
- .scale/
36
- docs/
37
- scripts/
38
- AGENTS.md 或对应 Agent 入口文档
39
- ```
40
-
41
- 重点看这些文件:
42
-
43
- | 文件 | 用途 |
44
- | --- | --- |
45
- | `.scale/verification.json` | 本地验证 profile 和服务矩阵 |
46
- | `.scale/skills.json` | Agent 应该如何选择 skills,以及哪些需要证据 |
47
- | `.scale/tools.json` | CLI、MCP、浏览器、桌面自动化等工具使用策略 |
48
- | `.scale/resource-policy.json` | 文档、报告、截图、脚本、临时产物的生命周期规则 |
49
- | `.scale/engineering-standards.json` | 日志、安全、ORM、框架、测试、部署等工程规范 |
50
- | `docs/workflow/templates/` | M/L 任务使用的标准 artifact 模板 |
51
-
52
- ## 3. 跑第一轮本地检查
53
-
54
- ```bash
55
- scale preflight --preflight-profile quick
56
- scale status
57
- scale assets scan --dir .
58
- scale standards scan --dir .
59
- scale runtime doctor --level S
60
- ```
61
-
62
- 预期效果:
63
-
64
- - `preflight` 能说明当前治理文件是否完整。
65
- - `status` 会告诉 Agent 下一步应该做什么。
66
- - `assets scan` 会把文档、模板、脚本、报告等资源分类。
67
- - `standards scan` 会扫描日志噪音、敏感信息、危险输入、测试和架构风险。
68
- - `runtime doctor` 会检查本地运行时证据目录和最终交付证据状态。
69
-
70
- ## 4. 建立第一个任务上下文
71
-
72
- ```bash
73
- scale context init --name "Scale Demo"
74
- scale runtime start --session-id 2026-05-18-oauth-hardening --task-id 2026-05-18-oauth-hardening --level M --agent codex
75
- scale context grill --task-id 2026-05-18-oauth-hardening --task "加固 OAuth callback"
76
- scale diagnose plan --task-id 2026-05-18-oauth-hardening --symptom "callback 在 state 过期时返回 500"
77
- scale tdd slice --task-id 2026-05-18-oauth-hardening --behavior "拒绝过期 OAuth state" --public-interface "GET /oauth/callback" --failing-test "expired state returns 401" --test-file tests/oauth.test.ts --impl-files src/oauth.ts
78
- ```
79
-
80
- 这些命令的目的不是替代人类判断,而是把 Agent 必须做的思考显式记录下来:
81
-
82
- - `context grill`:逼 Agent 先澄清上下文、成功标准和风险。
83
- - `diagnose plan`:遇到问题先诊断,不允许盲修。
84
- - `tdd slice`:把行为、公共接口、失败测试和实现文件绑定成一个可检查切片。
85
- - `runtime start`:建立会话 ledger,后续命令、工具和验证证据可以绑定到同一个任务。
86
-
87
- 完成真实验证后记录运行时证据:
88
-
89
- ```bash
90
- scale runtime record --title "quick preflight" --kind command --status passed --command "scale preflight --preflight-profile quick" --exit-code 0 --summary "quick preflight passed"
91
- scale runtime final-check --task-id 2026-05-18-oauth-hardening --session-id 2026-05-18-oauth-hardening --level M
92
- scale memory pack --task-id 2026-05-18-oauth-hardening --session-id 2026-05-18-oauth-hardening --task "继续加固 OAuth callback" --level M --budget 4000
93
- scale memory settle --task-id 2026-05-18-oauth-hardening --session-id 2026-05-18-oauth-hardening --task "继续加固 OAuth callback" --level M
94
- ```
95
-
96
- `memory pack` 用来恢复上下文,`memory settle` 用来在任务结束后生成学习候选。候选位于 `.scale/memory/learning-candidates/`,默认本地保留,确认稳定后再人工提升到知识库、规范或模块文档。
97
-
98
- ## 5. 生成 HTML 交付视图
99
-
100
- ```bash
101
- scale artifact render --task-id 2026-05-18-oauth-hardening --artifact-dir docs/worklog/tasks/2026-05-18-oauth-hardening
102
- scale artifact doctor --artifact-dir docs/worklog/tasks/2026-05-18-oauth-hardening
103
- scale artifact open --task-id 2026-05-18-oauth-hardening --artifact-dir docs/worklog/tasks/2026-05-18-oauth-hardening
104
- ```
105
-
106
- 规则:
107
-
108
- - Markdown 是长期维护源文件。
109
- - HTML 是给评审、对比、状态汇报、交付和发版使用的可视化产物。
110
- - `artifact doctor` 会检查 HTML 是否可追溯、是否引用远程资源、是否可能包含敏感信息。
111
-
112
- ## 6. 下一步
113
-
114
- 如果你只是试用,到这里已经能看到 SCALE 的价值:它把 Agent 的工作过程变成了可以审计的证据链。
115
-
116
- 如果你要接入真实项目,按项目类型选择 governance pack:
117
-
118
- ```bash
119
- scale init --governance-pack node-library
120
- scale init --governance-pack frontend-app
121
- scale init --governance-pack go-service-matrix
122
- scale init --governance-pack moe-workspace
123
- scale init --governance-pack resource-governance
124
- ```
125
-
126
- 继续阅读 [官方 Demo Walkthrough](agent-governance-demo.md),看一个真实任务如何从需求到验证证据。
127
-
1
+ # 3 分钟快速开始
2
+
3
+ 目标:在一个空目录中安装 SCALE 治理工作流,并看到可验证的项目产物。
4
+
5
+ ## 前置条件
6
+
7
+ - Node.js 20 或更高版本。
8
+ - 已安装 npm。
9
+ - Windows PowerShell、Git Bash、macOS/Linux shell 都可以执行。
10
+
11
+ ## 1. 安装 CLI
12
+
13
+ ```bash
14
+ npm install -g @hongmaple0820/scale-engine
15
+ scale --version
16
+ ```
17
+
18
+ 如果你在开发 `scale-engine` 本仓库,也可以用本地构建后的命令:
19
+
20
+ ```bash
21
+ node E:/project/scale-engine/dist/api/cli.js --help
22
+ ```
23
+
24
+ ## 2. 初始化一个空项目
25
+
26
+ ```bash
27
+ mkdir scale-demo
28
+ cd scale-demo
29
+ scale init --governance-pack standard
30
+ ```
31
+
32
+ 这一步会生成:
33
+
34
+ ```text
35
+ .scale/
36
+ docs/
37
+ scripts/
38
+ AGENTS.md 或对应 Agent 入口文档
39
+ ```
40
+
41
+ 重点看这些文件:
42
+
43
+ | 文件 | 用途 |
44
+ | --- | --- |
45
+ | `.scale/verification.json` | 本地验证 profile 和服务矩阵 |
46
+ | `.scale/skills.json` | Agent 应该如何选择 skills,以及哪些需要证据 |
47
+ | `.scale/tools.json` | CLI、MCP、浏览器、桌面自动化等工具使用策略 |
48
+ | `.scale/resource-policy.json` | 文档、报告、截图、脚本、临时产物的生命周期规则 |
49
+ | `.scale/engineering-standards.json` | 日志、安全、ORM、框架、测试、部署等工程规范 |
50
+ | `docs/workflow/templates/` | M/L 任务使用的标准 artifact 模板 |
51
+
52
+ ## 3. 跑第一轮本地检查
53
+
54
+ ```bash
55
+ scale preflight --preflight-profile quick
56
+ scale status
57
+ scale assets scan --dir .
58
+ scale standards scan --dir .
59
+ scale runtime doctor --level S
60
+ ```
61
+
62
+ 预期效果:
63
+
64
+ - `preflight` 能说明当前治理文件是否完整。
65
+ - `status` 会告诉 Agent 下一步应该做什么。
66
+ - `assets scan` 会把文档、模板、脚本、报告等资源分类。
67
+ - `standards scan` 会扫描日志噪音、敏感信息、危险输入、测试和架构风险。
68
+ - `runtime doctor` 会检查本地运行时证据目录和最终交付证据状态。
69
+
70
+ ## 4. 建立第一个任务上下文
71
+
72
+ ```bash
73
+ scale context init --name "Scale Demo"
74
+ scale runtime start --session-id 2026-05-18-oauth-hardening --task-id 2026-05-18-oauth-hardening --level M --agent codex
75
+ scale context grill --task-id 2026-05-18-oauth-hardening --task "加固 OAuth callback"
76
+ scale diagnose plan --task-id 2026-05-18-oauth-hardening --symptom "callback 在 state 过期时返回 500"
77
+ scale tdd slice --task-id 2026-05-18-oauth-hardening --behavior "拒绝过期 OAuth state" --public-interface "GET /oauth/callback" --failing-test "expired state returns 401" --test-file tests/oauth.test.ts --impl-files src/oauth.ts
78
+ ```
79
+
80
+ 这些命令的目的不是替代人类判断,而是把 Agent 必须做的思考显式记录下来:
81
+
82
+ - `context grill`:逼 Agent 先澄清上下文、成功标准和风险。
83
+ - `diagnose plan`:遇到问题先诊断,不允许盲修。
84
+ - `tdd slice`:把行为、公共接口、失败测试和实现文件绑定成一个可检查切片。
85
+ - `runtime start`:建立会话 ledger,后续命令、工具和验证证据可以绑定到同一个任务。
86
+
87
+ 完成真实验证后记录运行时证据:
88
+
89
+ ```bash
90
+ scale runtime record --title "quick preflight" --kind command --status passed --command "scale preflight --preflight-profile quick" --exit-code 0 --summary "quick preflight passed"
91
+ scale runtime final-check --task-id 2026-05-18-oauth-hardening --session-id 2026-05-18-oauth-hardening --level M
92
+ scale memory pack --task-id 2026-05-18-oauth-hardening --session-id 2026-05-18-oauth-hardening --task "继续加固 OAuth callback" --level M --budget 4000
93
+ scale memory settle --task-id 2026-05-18-oauth-hardening --session-id 2026-05-18-oauth-hardening --task "继续加固 OAuth callback" --level M
94
+ ```
95
+
96
+ `memory pack` 用来恢复上下文,`memory settle` 用来在任务结束后生成学习候选。候选位于 `.scale/memory/learning-candidates/`,默认本地保留,确认稳定后再人工提升到知识库、规范或模块文档。
97
+
98
+ ## 5. 生成 HTML 交付视图
99
+
100
+ ```bash
101
+ scale artifact render --task-id 2026-05-18-oauth-hardening --artifact-dir docs/worklog/tasks/2026-05-18-oauth-hardening
102
+ scale artifact doctor --artifact-dir docs/worklog/tasks/2026-05-18-oauth-hardening
103
+ scale artifact open --task-id 2026-05-18-oauth-hardening --artifact-dir docs/worklog/tasks/2026-05-18-oauth-hardening
104
+ ```
105
+
106
+ 规则:
107
+
108
+ - Markdown 是长期维护源文件。
109
+ - HTML 是给评审、对比、状态汇报、交付和发版使用的可视化产物。
110
+ - `artifact doctor` 会检查 HTML 是否可追溯、是否引用远程资源、是否可能包含敏感信息。
111
+
112
+ ## 6. 下一步
113
+
114
+ 如果你只是试用,到这里已经能看到 SCALE 的价值:它把 Agent 的工作过程变成了可以审计的证据链。
115
+
116
+ 如果你要接入真实项目,按项目类型选择 governance pack:
117
+
118
+ ```bash
119
+ scale init --governance-pack node-library
120
+ scale init --governance-pack frontend-app
121
+ scale init --governance-pack go-service-matrix
122
+ scale init --governance-pack moe-workspace
123
+ scale init --governance-pack resource-governance
124
+ ```
125
+
126
+ 已有项目升级工作流时不要盲目重跑 `scale init`。先走受保护的升级链路:
127
+
128
+ ```bash
129
+ scale upgrade check --dir . --lang zh
130
+ scale upgrade plan --dir . --html --lang zh
131
+ scale upgrade apply --dir . --confirm --lang zh
132
+ ```
133
+
134
+ 需要英文输出时把 `--lang zh` 换成 `--lang en`。干净的 SCALE 受管文件可以自动刷新;已有本地改动的文件会进入人工审阅,不会被自动覆盖。
135
+
136
+ 继续阅读 [官方 Demo Walkthrough](agent-governance-demo.md),看一个真实任务如何从需求到验证证据。
137
+