@hongmaple0820/scale-engine 0.25.0 → 0.26.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 (143) hide show
  1. package/LICENSE +15 -15
  2. package/README.en.md +368 -346
  3. package/README.md +548 -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 +133 -47
  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 +45 -45
  53. package/dist/context/AntiPatternRegistry.js +20 -20
  54. package/dist/context/ContextBuilder.js +155 -155
  55. package/dist/evolution/EvolutionEngine.js +31 -31
  56. package/dist/evolution/EvolutionEvaluator.d.ts +2 -0
  57. package/dist/evolution/EvolutionEvaluator.js +7 -1
  58. package/dist/evolution/EvolutionEvaluator.js.map +1 -1
  59. package/dist/fsm/FSMAgentBridge.js +11 -11
  60. package/dist/hooks/HookGeneratorEnhanced.js +218 -218
  61. package/dist/index.d.ts +1 -1
  62. package/dist/index.js +2 -2
  63. package/dist/index.js.map +1 -1
  64. package/dist/knowledge/SQLiteKnowledgeBase.js +28 -28
  65. package/dist/memory/MemoryBrain.js +52 -52
  66. package/dist/output/GovernanceDashboard.js +44 -44
  67. package/dist/output/HTMLArtifactLayer.js +31 -31
  68. package/dist/prompts/VibeTemplateGallery.js +121 -121
  69. package/dist/skills/SkillDiscovery.js +12 -1
  70. package/dist/skills/SkillDiscovery.js.map +1 -1
  71. package/dist/skills/routing/SkillPlanner.js +40 -40
  72. package/dist/workflow/EngineeringStandards.js +62 -62
  73. package/dist/workflow/GovernanceTemplatePacks.d.ts +1 -1
  74. package/dist/workflow/GovernanceTemplatePacks.js +1990 -162
  75. package/dist/workflow/GovernanceTemplatePacks.js.map +1 -1
  76. package/dist/workflow/GovernanceTemplates.d.ts +2 -0
  77. package/dist/workflow/GovernanceTemplates.js +1012 -1001
  78. package/dist/workflow/GovernanceTemplates.js.map +1 -1
  79. package/dist/workflow/ResourceGovernance.js +16 -16
  80. package/dist/workflow/TaskArtifactScaffolder.js +10 -10
  81. package/dist/workflow/UpgradeManager.d.ts +3 -2
  82. package/dist/workflow/UpgradeManager.js +134 -49
  83. package/dist/workflow/UpgradeManager.js.map +1 -1
  84. package/dist/workflow/WorkspaceTopology.js +18 -15
  85. package/dist/workflow/WorkspaceTopology.js.map +1 -1
  86. package/docs/ACTIVE_SECURITY_VISUAL_GATES.md +87 -87
  87. package/docs/BACKGROUND_HUNTER.md +62 -62
  88. package/docs/CODE_INTELLIGENCE.md +138 -138
  89. package/docs/CONTEXT_BUDGET.md +113 -113
  90. package/docs/DEPENDENCY_AUDIT.md +89 -89
  91. package/docs/EVOLUTION_SHADOW_MODE.md +63 -63
  92. package/docs/EXTERNAL_REFERENCES.md +63 -58
  93. package/docs/GITLAB_FLOW.md +125 -125
  94. package/docs/GOVERNANCE_DASHBOARD.md +85 -85
  95. package/docs/MEMORY_BRAIN.md +104 -104
  96. package/docs/MEMORY_FABRIC.md +134 -134
  97. package/docs/README.md +101 -92
  98. package/docs/RUNTIME_EVIDENCE.md +101 -101
  99. package/docs/SKILL-REPOSITORY.md +57 -57
  100. package/docs/SKILL_RADAR.md +122 -122
  101. package/docs/THIRD_PARTY_SKILLS.md +57 -57
  102. package/docs/WORKFLOW_EVAL.md +151 -151
  103. package/docs/guides/DEVELOPMENT_WORKFLOW.md +80 -0
  104. package/docs/guides/GETTING_STARTED.md +50 -0
  105. package/docs/start/README.md +78 -72
  106. package/docs/start/agent-governance-demo.md +107 -107
  107. package/docs/start/quickstart.md +137 -127
  108. package/docs/start/workflow-upgrade.md +32 -8
  109. package/docs/workflow/README.md +67 -0
  110. package/docs/workflow/node-library.md +52 -0
  111. package/docs/workflow/templates/api-contract.md +29 -0
  112. package/docs/workflow/templates/architecture-review.md +23 -0
  113. package/docs/workflow/templates/db-change-plan.md +20 -0
  114. package/docs/workflow/templates/docs-impact.md +17 -0
  115. package/docs/workflow/templates/e2e-plan.md +20 -0
  116. package/docs/workflow/templates/explore.md +16 -0
  117. package/docs/workflow/templates/github-actions-scale-preflight.yml +32 -0
  118. package/docs/workflow/templates/mini-prd.md +16 -0
  119. package/docs/workflow/templates/plan.md +37 -0
  120. package/docs/workflow/templates/pre-push-scale-preflight.sh +8 -0
  121. package/docs/workflow/templates/product-smoke.md +61 -0
  122. package/docs/workflow/templates/reality-check.md +28 -0
  123. package/docs/workflow/templates/resource-cleanup.md +17 -0
  124. package/docs/workflow/templates/resource-impact.md +25 -0
  125. package/docs/workflow/templates/review.md +12 -0
  126. package/docs/workflow/templates/runtime.md +23 -0
  127. package/docs/workflow/templates/security-review.md +26 -0
  128. package/docs/workflow/templates/skill-evidence.md +33 -0
  129. package/docs/workflow/templates/skill-plan.md +39 -0
  130. package/docs/workflow/templates/spec.md +17 -0
  131. package/docs/workflow/templates/standards-impact.md +28 -0
  132. package/docs/workflow/templates/summary.md +16 -0
  133. package/docs/workflow/templates/tasks.md +8 -0
  134. package/docs/workflow/templates/ui-spec.md +29 -0
  135. package/docs/workflow/templates/verification.md +20 -0
  136. package/docs/workflow/templates/visual-review.md +20 -0
  137. package/examples/demo-projects/agent-governance-demo/CONTEXT.md +14 -14
  138. package/examples/demo-projects/agent-governance-demo/README.md +48 -48
  139. package/examples/demo-projects/agent-governance-demo/docs/CONTEXT-MAP.md +14 -14
  140. package/examples/demo-projects/agent-governance-demo/package.json +22 -21
  141. package/examples/demo-projects/agent-governance-demo/src/oauth-state.ts +39 -39
  142. package/examples/demo-projects/agent-governance-demo/tests/oauth-state.test.ts +52 -52
  143. package/package.json +88 -78
@@ -1,58 +1,63 @@
1
- # External Reference Inventory
2
-
3
- This inventory is the source of truth for external projects, community skills, MCP servers, CLIs, and adapter targets referenced by SCALE. It complements [Third-Party Skills and External References](THIRD_PARTY_SKILLS.md).
4
-
5
- The inventory is intentionally conservative:
6
-
7
- - A row here is an acknowledgement and governance record, not a claim that upstream code is vendored.
8
- - License is only marked when it has been explicitly reviewed in this repository. Unknown or unverified projects stay `review-required`.
9
- - Any future vendoring, source copying, modified redistribution, bundled assets, logos, examples, or generated derivatives must preserve upstream license text, copyright notices, NOTICE files, source URL, pinned revision, and modification notes.
10
- - External services and memory providers remain disabled or read-only by default until privacy, retention, credential, and deletion boundaries are reviewed.
11
-
12
- ## Current References
13
-
14
- | Upstream | Role in SCALE | Usage status | License status | Primary source surface |
15
- | --- | --- | --- | --- | --- |
16
- | [OthmanAdi/planning-with-files](https://github.com/OthmanAdi/planning-with-files) | File-backed planning workflow reference | adapted concept, not vendored | MIT | `SkillRepository`, README, `THIRD_PARTY_SKILLS` |
17
- | [rohitg00/agentmemory](https://github.com/rohitg00/agentmemory) | Optional external memory provider | external provider, read-only by default | Apache-2.0 | `MemoryProviders`, `SkillRepository`, README |
18
- | [garrytan/gbrain](https://github.com/garrytan/gbrain) | Optional graph memory provider | external provider, read-only by default | MIT | `MemoryProviders`, `SkillRepository`, README |
19
- | [anthropics/skills](https://github.com/anthropics/skills) | Frontend and webapp testing skill references | external skill reference | review-required | `SkillRepository`, `SkillCatalog`, `ToolCapabilityRegistry` |
20
- | [anthropics/claude-code](https://github.com/anthropics/claude-code) | Graphify and playwright-interactive skill references | optional discovery reference | review-required | `SkillDiscovery` |
21
- | [VoltAgent/awesome-design-md](https://github.com/VoltAgent/awesome-design-md) | Design system and DESIGN.md guidance | external skill reference | review-required | `SkillRepository`, `ExternalSkills`, `SkillDoctor` |
22
- | [nextlevelbuilder/ui-ux-pro-max-skill](https://github.com/nextlevelbuilder/ui-ux-pro-max-skill) | UI/UX design intelligence reference | external skill reference | review-required | `SkillRepository`, `ExternalSkills`, `ToolCapabilityRegistry` |
23
- | [eze-is/web-access](https://github.com/eze-is/web-access) | Web research and browser automation skill | external skill reference | review-required | `SkillRepository`, `ExternalSkills`, `SkillDoctor` |
24
- | [vercel-labs/agent-browser](https://github.com/vercel-labs/agent-browser) | Browser automation CLI | external CLI reference | review-required | `SkillRepository`, `ExternalSkills`, `ToolCapabilityRegistry` |
25
- | [ChromeDevTools/chrome-devtools-mcp](https://github.com/ChromeDevTools/chrome-devtools-mcp) | Chrome DevTools MCP integration | MCP reference | review-required | `SkillRepository`, `ExternalSkills`, `ToolCapabilityRegistry` |
26
- | [trycua/cua](https://github.com/trycua/cua) | Desktop computer-use automation | restricted external automation reference | review-required | `SkillRepository`, `ExternalSkills`, `ToolCapabilityRegistry` |
27
- | [microsoft/playwright](https://github.com/microsoft/playwright) | Browser automation and validation | optional discovery reference | review-required | `SkillDiscovery` |
28
- | [google-gemini/gemini-cli](https://github.com/google-gemini/gemini-cli) | Gemini CLI and community skill examples | external CLI and skill reference | review-required | `SkillRepository`, `SkillCatalog`, adapters |
29
- | [openai/codex](https://github.com/openai/codex) | Codex CLI adapter and external reviewer | external CLI reference | review-required | `SkillRepository`, `ExternalSkills`, adapters |
30
- | [sst/opencode](https://github.com/sst/opencode) | OpenCode CLI reference used by routing | external CLI reference | review-required | `SkillRepository`, `ExternalSkills`, `SkillDoctor` |
31
- | [opencode-ai/opencode](https://github.com/opencode-ai/opencode) | OpenCode adapter source comment | adapter target reference | review-required | `OpenCodeAdapter` |
32
- | [facebook/react](https://github.com/facebook/react) | React fix skill example | external skill reference | review-required | `SkillRepository`, `SkillCatalog` |
33
- | [vercel/next.js](https://github.com/vercel/next.js) | Next.js documentation update skill example | external skill reference | review-required | `SkillRepository`, `SkillCatalog` |
34
- | [vercel-labs/skills](https://github.com/vercel-labs/skills) | Skill discovery example | external skill reference | review-required | `SkillRepository`, `SkillCatalog` |
35
- | [Shubhamsaboo/awesome-llm-apps](https://github.com/Shubhamsaboo/awesome-llm-apps) | Full-stack agent skill example | external skill reference | review-required | `SkillCatalog` |
36
- | [jnMetaCode/agency-agents-zh](https://github.com/jnMetaCode/agency-agents-zh) | Chinese role preset reference | external preset reference | review-required | `SkillRepository` |
37
- | [yizhiyanhua-ai/fireworks-tech-graph](https://github.com/yizhiyanhua-ai/fireworks-tech-graph) | Diagram skill discovery and installer reference | optional install reference | review-required | `ExternalSkills`, `SkillDiscovery`, `SkillInstaller` |
38
- | [github/awesome-copilot](https://github.com/github/awesome-copilot) | Excalidraw diagram skill source | optional install reference | review-required | `ExternalSkills`, `SkillInstaller`, installation workflow doc |
39
- | [Cocoon-AI/architecture-diagram-generator](https://github.com/Cocoon-AI/architecture-diagram-generator) | Architecture diagram skill reference | optional install reference | review-required | `ExternalSkills`, `SkillDiscovery`, `SkillInstaller` |
40
- | [heygen-com/hyperframes](https://github.com/heygen-com/hyperframes) | Video generation CLI reference | optional install reference | review-required | `ExternalSkills`, `SkillDiscovery`, `SkillInstaller` |
41
- | [op7418/guizang-ppt-skill](https://github.com/op7418/guizang-ppt-skill) | PPT generation skill reference | optional install reference | review-required | `ExternalSkills`, `SkillDiscovery`, `SkillInstaller` |
42
- | [QwenLM/qwen-code](https://github.com/QwenLM/qwen-code) | QCoder adapter target | adapter target reference | review-required | `QCoderAdapter` |
43
- | [openclaw-ai/openclaw](https://github.com/openclaw-ai/openclaw) | OpenClaw adapter target | adapter target reference | review-required | `OpenClawAdapter` |
44
- | [hermes-ai/hermes](https://github.com/hermes-ai/hermes) | Hermes adapter target | adapter target reference | review-required | `HermesAdapter` |
45
- | [Hmbown/deepseek-tui](https://github.com/Hmbown/deepseek-tui) | DeepSeek TUI adapter target | adapter target reference | review-required | `DeepSeekTuiAdapter` |
46
- | [Aider-AI/aider](https://github.com/Aider-AI/aider) | Aider adapter target | adapter target reference | review-required | `AiderAdapter` |
47
-
48
- ## Required Maintenance
49
-
50
- When a new GitHub upstream is referenced from `src/skills`, `src/tools`, `src/adapters`, or current tool orchestration docs, update this inventory in the same change. `tests/docs/externalReferences.test.ts` scans those surfaces and fails if a referenced upstream is missing from this file.
51
-
52
- Before promoting any `review-required` item to a declared license status, record:
53
-
54
- 1. upstream license file and revision
55
- 2. upstream copyright and NOTICE obligations
56
- 3. whether SCALE vendors code, adapts concepts, or only links to the project
57
- 4. modification notes for copied or derived files
58
- 5. installation, script, and permission review evidence
1
+ # External Reference Inventory
2
+
3
+ This inventory is the source of truth for external projects, community skills, MCP servers, CLIs, and adapter targets referenced by SCALE. It complements [Third-Party Skills and External References](THIRD_PARTY_SKILLS.md).
4
+
5
+ The inventory is intentionally conservative:
6
+
7
+ - A row here is an acknowledgement and governance record, not a claim that upstream code is vendored.
8
+ - License is only marked when it has been explicitly reviewed in this repository. Unknown or unverified projects stay `review-required`.
9
+ - Any future vendoring, source copying, modified redistribution, bundled assets, logos, examples, or generated derivatives must preserve upstream license text, copyright notices, NOTICE files, source URL, pinned revision, and modification notes.
10
+ - External services and memory providers remain disabled or read-only by default until privacy, retention, credential, and deletion boundaries are reviewed.
11
+
12
+ ## Current References
13
+
14
+ | Upstream | Role in SCALE | Usage status | License status | Primary source surface |
15
+ | --- | --- | --- | --- | --- |
16
+ | [OthmanAdi/planning-with-files](https://github.com/OthmanAdi/planning-with-files) | File-backed planning workflow reference | adapted concept, not vendored | MIT | `SkillRepository`, README, `THIRD_PARTY_SKILLS` |
17
+ | [rohitg00/agentmemory](https://github.com/rohitg00/agentmemory) | Optional external memory provider | external provider, read-only by default | Apache-2.0 | `MemoryProviders`, `SkillRepository`, README |
18
+ | [garrytan/gbrain](https://github.com/garrytan/gbrain) | Optional graph memory provider | external provider, read-only by default | MIT | `MemoryProviders`, `SkillRepository`, README |
19
+ | [anthropics/skills](https://github.com/anthropics/skills) | Frontend and webapp testing skill references | external skill reference | review-required | `SkillRepository`, `SkillCatalog`, `ToolCapabilityRegistry` |
20
+ | [anthropics/claude-code](https://github.com/anthropics/claude-code) | Graphify and playwright-interactive skill references | optional discovery reference | review-required | `SkillDiscovery` |
21
+ | [VoltAgent/awesome-design-md](https://github.com/VoltAgent/awesome-design-md) | Design system and DESIGN.md guidance | external skill reference | review-required | `SkillRepository`, `ExternalSkills`, `SkillDoctor` |
22
+ | [nextlevelbuilder/ui-ux-pro-max-skill](https://github.com/nextlevelbuilder/ui-ux-pro-max-skill) | UI/UX design intelligence reference | external skill reference | review-required | `SkillRepository`, `ExternalSkills`, `ToolCapabilityRegistry` |
23
+ | [eze-is/web-access](https://github.com/eze-is/web-access) | Web research and browser automation skill | external skill reference | review-required | `SkillRepository`, `ExternalSkills`, `SkillDoctor` |
24
+ | [vercel-labs/agent-browser](https://github.com/vercel-labs/agent-browser) | Browser automation CLI | external CLI reference | review-required | `SkillRepository`, `ExternalSkills`, `ToolCapabilityRegistry` |
25
+ | [ChromeDevTools/chrome-devtools-mcp](https://github.com/ChromeDevTools/chrome-devtools-mcp) | Chrome DevTools MCP integration | MCP reference | review-required | `SkillRepository`, `ExternalSkills`, `ToolCapabilityRegistry` |
26
+ | [trycua/cua](https://github.com/trycua/cua) | Desktop computer-use automation | restricted external automation reference | review-required | `SkillRepository`, `ExternalSkills`, `ToolCapabilityRegistry` |
27
+ | [microsoft/playwright](https://github.com/microsoft/playwright) | Browser automation and validation | optional discovery reference | review-required | `SkillDiscovery` |
28
+ | [google-gemini/gemini-cli](https://github.com/google-gemini/gemini-cli) | Gemini CLI and community skill examples | external CLI and skill reference | review-required | `SkillRepository`, `SkillCatalog`, adapters |
29
+ | [openai/codex](https://github.com/openai/codex) | Codex CLI adapter and external reviewer | external CLI reference | review-required | `SkillRepository`, `ExternalSkills`, adapters |
30
+ | [sst/opencode](https://github.com/sst/opencode) | OpenCode CLI reference used by routing | external CLI reference | review-required | `SkillRepository`, `ExternalSkills`, `SkillDoctor` |
31
+ | [opencode-ai/opencode](https://github.com/opencode-ai/opencode) | OpenCode adapter source comment | adapter target reference | review-required | `OpenCodeAdapter` |
32
+ | [facebook/react](https://github.com/facebook/react) | React fix skill example | external skill reference | review-required | `SkillRepository`, `SkillCatalog` |
33
+ | [vercel/next.js](https://github.com/vercel/next.js) | Next.js documentation update skill example | external skill reference | review-required | `SkillRepository`, `SkillCatalog` |
34
+ | [vercel-labs/skills](https://github.com/vercel-labs/skills) | Skill discovery example | external skill reference | review-required | `SkillRepository`, `SkillCatalog` |
35
+ | [Shubhamsaboo/awesome-llm-apps](https://github.com/Shubhamsaboo/awesome-llm-apps) | Full-stack agent skill example | external skill reference | review-required | `SkillCatalog` |
36
+ | [jnMetaCode/agency-agents-zh](https://github.com/jnMetaCode/agency-agents-zh) | Chinese role preset reference | external preset reference | review-required | `SkillRepository` |
37
+ | [yizhiyanhua-ai/fireworks-tech-graph](https://github.com/yizhiyanhua-ai/fireworks-tech-graph) | Diagram skill discovery and installer reference | optional install reference | review-required | `ExternalSkills`, `SkillDiscovery`, `SkillInstaller` |
38
+ | [github/awesome-copilot](https://github.com/github/awesome-copilot) | Excalidraw diagram skill source | optional install reference | review-required | `ExternalSkills`, `SkillInstaller`, installation workflow doc |
39
+ | [Cocoon-AI/architecture-diagram-generator](https://github.com/Cocoon-AI/architecture-diagram-generator) | Architecture diagram skill reference | optional install reference | review-required | `ExternalSkills`, `SkillDiscovery`, `SkillInstaller` |
40
+ | [heygen-com/hyperframes](https://github.com/heygen-com/hyperframes) | Video generation CLI reference | optional install reference | review-required | `ExternalSkills`, `SkillDiscovery`, `SkillInstaller` |
41
+ | [op7418/guizang-ppt-skill](https://github.com/op7418/guizang-ppt-skill) | PPT generation skill reference | optional install reference | review-required | `ExternalSkills`, `SkillDiscovery`, `SkillInstaller` |
42
+ | [QwenLM/qwen-code](https://github.com/QwenLM/qwen-code) | QCoder adapter target | adapter target reference | review-required | `QCoderAdapter` |
43
+ | [Qoder docs](https://docs.qoder.com/) | Qoder adapter target | adapter target reference | review-required | `QoderAdapter` |
44
+ | JCode | JCode adapter target; upstream source and license still need review | provisional adapter target reference | review-required | `JCodeAdapter` |
45
+ | [Cline docs](https://docs.cline.bot/) | Cline adapter target | adapter target reference | review-required | `ClineAdapter` |
46
+ | [Kilo Code docs](https://docs.kilocode.ai/) | Kilo Code adapter target | adapter target reference | review-required | `KiloCodeAdapter` |
47
+ | [Google Antigravity docs](https://antigravity.google/docs/) | Antigravity adapter target | adapter target reference | review-required | `AntigravityAdapter` |
48
+ | [openclaw-ai/openclaw](https://github.com/openclaw-ai/openclaw) | OpenClaw adapter target | adapter target reference | review-required | `OpenClawAdapter` |
49
+ | [hermes-ai/hermes](https://github.com/hermes-ai/hermes) | Hermes adapter target | adapter target reference | review-required | `HermesAdapter` |
50
+ | [Hmbown/deepseek-tui](https://github.com/Hmbown/deepseek-tui) | DeepSeek TUI adapter target | adapter target reference | review-required | `DeepSeekTuiAdapter` |
51
+ | [Aider-AI/aider](https://github.com/Aider-AI/aider) | Aider adapter target | adapter target reference | review-required | `AiderAdapter` |
52
+
53
+ ## Required Maintenance
54
+
55
+ When a new GitHub upstream is referenced from `src/skills`, `src/tools`, `src/adapters`, or current tool orchestration docs, update this inventory in the same change. `tests/docs/externalReferences.test.ts` scans those surfaces and fails if a referenced upstream is missing from this file.
56
+
57
+ Before promoting any `review-required` item to a declared license status, record:
58
+
59
+ 1. upstream license file and revision
60
+ 2. upstream copyright and NOTICE obligations
61
+ 3. whether SCALE vendors code, adapts concepts, or only links to the project
62
+ 4. modification notes for copied or derived files
63
+ 5. installation, script, and permission review evidence
@@ -1,125 +1,125 @@
1
- # GitLab Flow Branch and Worktree Policy
2
-
3
- SCALE Engine uses a GitLab Flow variant for this repository:
4
-
5
- ```text
6
- feat/* / fix/* / chore/* / docs/* / codex/*
7
- -> dev
8
- -> master
9
- -> vX.Y.Z tag
10
- -> npm publish
11
-
12
- hotfix:
13
- fix forward on dev first when possible
14
- -> cherry-pick to hotfix/*
15
- -> master
16
- -> vX.Y.Z tag
17
- -> sync master back to dev
18
-
19
- selective release, only when dev contains work that must not ship:
20
- master
21
- -> release/vX.Y.Z
22
- -> cherry-pick selected commits
23
- -> master
24
- -> vX.Y.Z tag
25
- -> sync master back to dev
26
- ```
27
-
28
- ## Branch Roles
29
-
30
- | Branch | Role | Rule |
31
- | --- | --- | --- |
32
- | `dev` | Integration and test branch | Merge reviewed short branches here. Do not create direct governed commits on `dev`. |
33
- | `master` | Production branch | Only verified release/hotfix results land here. Publish from user-created `vX.Y.Z` tags on `master`. |
34
- | `feat/*`, `feature/*` | Feature branches | Start from current `dev`, merge back to `dev`, then delete. |
35
- | `fix/*` | Normal bug fix branches | Start from current `dev`, merge back to `dev`, then delete. |
36
- | `chore/*`, `docs/*`, `codex/*` | Maintenance branches | Short-lived work branches that merge back to `dev`. |
37
- | `hotfix/*` | Production patch branches | Use only for production fixes. Fix forward to `dev` first when possible, then cherry-pick to hotfix/master. |
38
- | `release/*` | Selective release branch | Use only when `dev` contains work that must not ship. Start from `master` and cherry-pick the release list. |
39
-
40
- ## Required Checks
41
-
42
- Run the release-grade verification set before merging to `master` or tagging:
43
-
44
- ```bash
45
- npm run build
46
- npx vitest run
47
- git diff --check
48
- npm pack --dry-run
49
- ```
50
-
51
- Every merge request should run the relevant build/lint/test checks before review is accepted. Do not wait until `master` to discover broken tests.
52
-
53
- ## Merge and Conflict Rules
54
-
55
- - Public branches are not rebased: `dev`, `master`, `release/*`, and `hotfix/*` keep realistic history.
56
- - Personal short branches may be rebased before merge, but only with `--force-with-lease` and only before review is accepted.
57
- - Prefer squash merge from short branches into `dev` when one logical change should be easy to revert.
58
- - Resolve conflicts on the source branch, rerun verification, then merge. Do not resolve release conflicts directly on `master`.
59
- - Fix bugs forward first: land the fix on `dev` when possible, then cherry-pick the same commit to `hotfix/*` or the selected patch release branch.
60
- - Commit messages should explain intent and why the chosen path was selected when the decision is not obvious.
61
-
62
- ## Ship Gate Rules
63
-
64
- `scale ship <task-id>` now enforces the branch lifecycle:
65
-
66
- - blocked on `dev`, `master`, `main`, and detached HEAD
67
- - allowed on configured short branches such as `feat/*`, `fix/*`, `chore/*`, `docs/*`, `codex/*`, `release/*`, and `hotfix/*`
68
- - still requires verification evidence, passing review evidence, and reviewed-file-only staging
69
- - still blocks dirty or unsafe child repositories in MOE/submodule workspaces
70
-
71
- Use:
72
-
73
- ```bash
74
- scale workspace status --summary
75
- scale workspace finish --summary
76
- scale workspace finish --json
77
- ```
78
-
79
- The report includes branch role, whether governed shipping is allowed, and cleanup blockers.
80
-
81
- ## Worktree Lifecycle
82
-
83
- Temporary agent worktrees are safe to remove only when all of these are true:
84
-
85
- - root worktree is clean
86
- - child repositories are clean and pushed when required
87
- - the temporary branch has no unpushed commits
88
- - a branch with no upstream is already merged into `dev`/`master`, or it contains no unique work
89
-
90
- Cleanup remains dry-run by default:
91
-
92
- ```bash
93
- scale workspace cleanup --dir <temporary-worktree> --dry-run --json
94
- scale workspace cleanup --dir <temporary-worktree> --apply --confirm <branch-or-head> --json
95
- ```
96
-
97
- If cleanup is blocked, push the branch, merge it, cherry-pick it into the selected release, or explicitly discard it before removing the worktree.
98
-
99
- ## Repository Bootstrap
100
-
101
- This repository currently treats `dev` as the integration branch and `master` as production. If `dev` falls behind `master` and has no unique commits, fast-forward `dev` to `master` before starting new feature work:
102
-
103
- ```bash
104
- git fetch --all --prune
105
- git switch dev
106
- git merge --ff-only master
107
- git push origin dev
108
- git push github dev
109
- ```
110
-
111
- After that, normal work should start from `dev`:
112
-
113
- ```bash
114
- git switch dev
115
- git pull --ff-only origin dev
116
- git switch -c feat/<short-name>
117
- ```
118
-
119
- Before creating a normal release from `dev`, inspect the release delta:
120
-
121
- ```bash
122
- git log --oneline master..dev
123
- ```
124
-
125
- If every listed commit is intended for the next production release, merge `dev` through the normal release path. If any commit must be excluded, create `release/vX.Y.Z` from `master` and cherry-pick only the approved release list.
1
+ # GitLab Flow Branch and Worktree Policy
2
+
3
+ SCALE Engine uses a GitLab Flow variant for this repository:
4
+
5
+ ```text
6
+ feat/* / fix/* / chore/* / docs/* / codex/*
7
+ -> dev
8
+ -> master
9
+ -> vX.Y.Z tag
10
+ -> npm publish
11
+
12
+ hotfix:
13
+ fix forward on dev first when possible
14
+ -> cherry-pick to hotfix/*
15
+ -> master
16
+ -> vX.Y.Z tag
17
+ -> sync master back to dev
18
+
19
+ selective release, only when dev contains work that must not ship:
20
+ master
21
+ -> release/vX.Y.Z
22
+ -> cherry-pick selected commits
23
+ -> master
24
+ -> vX.Y.Z tag
25
+ -> sync master back to dev
26
+ ```
27
+
28
+ ## Branch Roles
29
+
30
+ | Branch | Role | Rule |
31
+ | --- | --- | --- |
32
+ | `dev` | Integration and test branch | Merge reviewed short branches here. Do not create direct governed commits on `dev`. |
33
+ | `master` | Production branch | Only verified release/hotfix results land here. Publish from user-created `vX.Y.Z` tags on `master`. |
34
+ | `feat/*`, `feature/*` | Feature branches | Start from current `dev`, merge back to `dev`, then delete. |
35
+ | `fix/*` | Normal bug fix branches | Start from current `dev`, merge back to `dev`, then delete. |
36
+ | `chore/*`, `docs/*`, `codex/*` | Maintenance branches | Short-lived work branches that merge back to `dev`. |
37
+ | `hotfix/*` | Production patch branches | Use only for production fixes. Fix forward to `dev` first when possible, then cherry-pick to hotfix/master. |
38
+ | `release/*` | Selective release branch | Use only when `dev` contains work that must not ship. Start from `master` and cherry-pick the release list. |
39
+
40
+ ## Required Checks
41
+
42
+ Run the release-grade verification set before merging to `master` or tagging:
43
+
44
+ ```bash
45
+ npm run build
46
+ npx vitest run
47
+ git diff --check
48
+ npm pack --dry-run
49
+ ```
50
+
51
+ Every merge request should run the relevant build/lint/test checks before review is accepted. Do not wait until `master` to discover broken tests.
52
+
53
+ ## Merge and Conflict Rules
54
+
55
+ - Public branches are not rebased: `dev`, `master`, `release/*`, and `hotfix/*` keep realistic history.
56
+ - Personal short branches may be rebased before merge, but only with `--force-with-lease` and only before review is accepted.
57
+ - Prefer squash merge from short branches into `dev` when one logical change should be easy to revert.
58
+ - Resolve conflicts on the source branch, rerun verification, then merge. Do not resolve release conflicts directly on `master`.
59
+ - Fix bugs forward first: land the fix on `dev` when possible, then cherry-pick the same commit to `hotfix/*` or the selected patch release branch.
60
+ - Commit messages should explain intent and why the chosen path was selected when the decision is not obvious.
61
+
62
+ ## Ship Gate Rules
63
+
64
+ `scale ship <task-id>` now enforces the branch lifecycle:
65
+
66
+ - blocked on `dev`, `master`, `main`, and detached HEAD
67
+ - allowed on configured short branches such as `feat/*`, `fix/*`, `chore/*`, `docs/*`, `codex/*`, `release/*`, and `hotfix/*`
68
+ - still requires verification evidence, passing review evidence, and reviewed-file-only staging
69
+ - still blocks dirty or unsafe child repositories in MOE/submodule workspaces
70
+
71
+ Use:
72
+
73
+ ```bash
74
+ scale workspace status --summary
75
+ scale workspace finish --summary
76
+ scale workspace finish --json
77
+ ```
78
+
79
+ The report includes branch role, whether governed shipping is allowed, and cleanup blockers.
80
+
81
+ ## Worktree Lifecycle
82
+
83
+ Temporary agent worktrees are safe to remove only when all of these are true:
84
+
85
+ - root worktree is clean
86
+ - child repositories are clean and pushed when required
87
+ - the temporary branch has no unpushed commits
88
+ - a branch with no upstream is already merged into `dev`/`master`, or it contains no unique work
89
+
90
+ Cleanup remains dry-run by default:
91
+
92
+ ```bash
93
+ scale workspace cleanup --dir <temporary-worktree> --dry-run --json
94
+ scale workspace cleanup --dir <temporary-worktree> --apply --confirm <branch-or-head> --json
95
+ ```
96
+
97
+ If cleanup is blocked, push the branch, merge it, cherry-pick it into the selected release, or explicitly discard it before removing the worktree.
98
+
99
+ ## Repository Bootstrap
100
+
101
+ This repository currently treats `dev` as the integration branch and `master` as production. If `dev` falls behind `master` and has no unique commits, fast-forward `dev` to `master` before starting new feature work:
102
+
103
+ ```bash
104
+ git fetch --all --prune
105
+ git switch dev
106
+ git merge --ff-only master
107
+ git push origin dev
108
+ git push github dev
109
+ ```
110
+
111
+ After that, normal work should start from `dev`:
112
+
113
+ ```bash
114
+ git switch dev
115
+ git pull --ff-only origin dev
116
+ git switch -c feat/<short-name>
117
+ ```
118
+
119
+ Before creating a normal release from `dev`, inspect the release delta:
120
+
121
+ ```bash
122
+ git log --oneline master..dev
123
+ ```
124
+
125
+ If every listed commit is intended for the next production release, merge `dev` through the normal release path. If any commit must be excluded, create `release/vX.Y.Z` from `master` and cherry-pick only the approved release list.
@@ -1,85 +1,85 @@
1
- # Governance Dashboard
2
-
3
- Status: implemented baseline
4
- Since: v0.25 development branch
5
-
6
- Governance Dashboard turns existing SCALE evidence into a single reviewable HTML page. It does not replace Markdown, JSON, runtime evidence, eval records, or memory. It is a human-facing view over those sources.
7
-
8
- ## Command
9
-
10
- ```bash
11
- scale artifact dashboard
12
- scale artifact dashboard --task-id <task-id>
13
- scale artifact dashboard --dir /path/to/project
14
- scale artifact dashboard --output docs/worklog/tasks/<task-id>/artifacts/governance-dashboard.html
15
- scale artifact dashboard --json
16
- ```
17
-
18
- Default output:
19
-
20
- ```text
21
- .scale/reports/governance-dashboard.html
22
- .scale/reports/governance-dashboard-manifest.json
23
- ```
24
-
25
- The default lifecycle is `generated-report` and the default Git policy is `ignore`. Promote or commit only dashboards that are intentionally used as reviewed task evidence or release evidence.
26
-
27
- When `--dir` is used and `SCALE_DIR` is not set, the default `.scale` directory is resolved inside the target project directory, not inside the shell's current working directory. This matters for scaffold and multi-repo validation runs.
28
-
29
- ## Inputs
30
-
31
- The dashboard reads existing local evidence:
32
-
33
- | Area | Source |
34
- | --- | --- |
35
- | Runtime evidence | `.scale/evidence/runtime/` |
36
- | Workflow eval | `.scale/evals/runs/` and `.scale/evals/failures/` |
37
- | Workflow metrics | `.scale/metrics/tasks.jsonl` |
38
- | Gate evidence | `.scale/evidence/GATE-*.json` |
39
- | Command runs | `.scale/evidence/command-runs/` |
40
- | Model usage | `.scale/model-usage/usage.jsonl` |
41
- | Memory Brain | `.scale/memory/brain.sqlite` |
42
- | Resource Governance | workspace files plus `.scale/resource-policy.json` and `.scale/assets.json` |
43
- | HTML artifacts | task artifact manifests and rendered HTML files |
44
-
45
- ## Aggregated Metrics
46
-
47
- V2.0 adds `MetricsAggregator` as the dashboard aggregation layer. It keeps the dashboard read-only and derives the following metrics from existing evidence:
48
-
49
- - recent task count and first-pass rate
50
- - average fix iterations
51
- - gate failure distribution
52
- - command output compression token savings
53
- - model usage and prompt-cache savings
54
-
55
- Each number must trace back to local JSON/JSONL evidence. If a source is absent, the dashboard reports zero rather than inventing values.
56
-
57
- ## Status Model
58
-
59
- - Runtime evidence failures are blocking.
60
- - Memory contradictions are blocking.
61
- - Resource Governance failures are blocking.
62
- - Open eval failure replays are warnings, because they may be intentional baseline failures or pending improvement work.
63
- - Missing task HTML artifacts are informational.
64
-
65
- This keeps the dashboard useful as a review surface without turning every observation into a hard gate.
66
-
67
- ## Recommended Use
68
-
69
- For M/L/CRITICAL work:
70
-
71
- ```bash
72
- scale verify <task-id>
73
- scale eval run --suite workflow-baseline
74
- scale memory dream --json
75
- scale artifact dashboard --task-id <task-id>
76
- ```
77
-
78
- For release review:
79
-
80
- ```bash
81
- scale artifact dashboard
82
- scale artifact open --artifact-dir .scale/reports --type governance-dashboard --print-only
83
- ```
84
-
85
- The dashboard should be attached to a release or PR only when it is deliberately selected as a review artifact. Routine generated dashboards should stay local.
1
+ # Governance Dashboard
2
+
3
+ Status: implemented baseline
4
+ Since: v0.25 development branch
5
+
6
+ Governance Dashboard turns existing SCALE evidence into a single reviewable HTML page. It does not replace Markdown, JSON, runtime evidence, eval records, or memory. It is a human-facing view over those sources.
7
+
8
+ ## Command
9
+
10
+ ```bash
11
+ scale artifact dashboard
12
+ scale artifact dashboard --task-id <task-id>
13
+ scale artifact dashboard --dir /path/to/project
14
+ scale artifact dashboard --output docs/worklog/tasks/<task-id>/artifacts/governance-dashboard.html
15
+ scale artifact dashboard --json
16
+ ```
17
+
18
+ Default output:
19
+
20
+ ```text
21
+ .scale/reports/governance-dashboard.html
22
+ .scale/reports/governance-dashboard-manifest.json
23
+ ```
24
+
25
+ The default lifecycle is `generated-report` and the default Git policy is `ignore`. Promote or commit only dashboards that are intentionally used as reviewed task evidence or release evidence.
26
+
27
+ When `--dir` is used and `SCALE_DIR` is not set, the default `.scale` directory is resolved inside the target project directory, not inside the shell's current working directory. This matters for scaffold and multi-repo validation runs.
28
+
29
+ ## Inputs
30
+
31
+ The dashboard reads existing local evidence:
32
+
33
+ | Area | Source |
34
+ | --- | --- |
35
+ | Runtime evidence | `.scale/evidence/runtime/` |
36
+ | Workflow eval | `.scale/evals/runs/` and `.scale/evals/failures/` |
37
+ | Workflow metrics | `.scale/metrics/tasks.jsonl` |
38
+ | Gate evidence | `.scale/evidence/GATE-*.json` |
39
+ | Command runs | `.scale/evidence/command-runs/` |
40
+ | Model usage | `.scale/model-usage/usage.jsonl` |
41
+ | Memory Brain | `.scale/memory/brain.sqlite` |
42
+ | Resource Governance | workspace files plus `.scale/resource-policy.json` and `.scale/assets.json` |
43
+ | HTML artifacts | task artifact manifests and rendered HTML files |
44
+
45
+ ## Aggregated Metrics
46
+
47
+ V2.0 adds `MetricsAggregator` as the dashboard aggregation layer. It keeps the dashboard read-only and derives the following metrics from existing evidence:
48
+
49
+ - recent task count and first-pass rate
50
+ - average fix iterations
51
+ - gate failure distribution
52
+ - command output compression token savings
53
+ - model usage and prompt-cache savings
54
+
55
+ Each number must trace back to local JSON/JSONL evidence. If a source is absent, the dashboard reports zero rather than inventing values.
56
+
57
+ ## Status Model
58
+
59
+ - Runtime evidence failures are blocking.
60
+ - Memory contradictions are blocking.
61
+ - Resource Governance failures are blocking.
62
+ - Open eval failure replays are warnings, because they may be intentional baseline failures or pending improvement work.
63
+ - Missing task HTML artifacts are informational.
64
+
65
+ This keeps the dashboard useful as a review surface without turning every observation into a hard gate.
66
+
67
+ ## Recommended Use
68
+
69
+ For M/L/CRITICAL work:
70
+
71
+ ```bash
72
+ scale verify <task-id>
73
+ scale eval run --suite workflow-baseline
74
+ scale memory dream --json
75
+ scale artifact dashboard --task-id <task-id>
76
+ ```
77
+
78
+ For release review:
79
+
80
+ ```bash
81
+ scale artifact dashboard
82
+ scale artifact open --artifact-dir .scale/reports --type governance-dashboard --print-only
83
+ ```
84
+
85
+ The dashboard should be attached to a release or PR only when it is deliberately selected as a review artifact. Routine generated dashboards should stay local.