contract diagram
/install contract-diagram
| Legend | Description |
|---|---|
| Not discussed yet | |
| Agreed by stakeholders | |
| Needs discussion/failed implementation (always has notes) | |
| Agreed and implemented | |
| Implemented but developer made decisions (in notes) | |
| (dashed border) To be performed outside system |
SKILL contract diagram
ℹ️
%%{init: {'theme':'base','themeVariables':{"primaryColor":"#4A90E2","primaryTextColor":"#fff","primaryBorderColor":"#2E5C8A","lineColor":"#666","secondaryColor":"#50E3C2","tertiaryColor":"#FFD700","edgeLabelBackground":"#666"},'flowchart':{"nodeSpacing":50,"rankSpacing":50,"padding":15,"curve":"basis"}}}%%
flowchart TD
TRIGGER["Trigger + contract"]
CHECK_CONTRACT{"Has contract?"}
OPEN["Open contract"]
CLARIFY["Clarify"]
CHECK_DIAGRAM{"Has diagram?"}
CREATE["New 1️⃣"]
CLAIM["Claimed 1️⃣"]
ERROR["Error 2️⃣"]
DESIGN["Design phase"]
SIGNOFF["Ready to approve"]
DEVELOPMENT["Developing..."]
BLOCKERS{"Has blockers?"}
TESTS{"Pass checks? 3️⃣"}
PUBLISH["Publish 3️⃣"]
TRIGGER --> CHECK_CONTRACT
CHECK_CONTRACT -->|Yes| OPEN
CHECK_CONTRACT -->|Yes but\x3Cbr/>not editable| ERROR
CHECK_CONTRACT -->|No| CLARIFY
CLARIFY --> TRIGGER
OPEN --> CHECK_DIAGRAM
CHECK_DIAGRAM -->|Yes, more\x3Cbr/>than one| ERROR
CHECK_DIAGRAM -->|Yes, one| CLAIM
CHECK_DIAGRAM -->|No| CREATE
CREATE --> DESIGN
CLAIM --> DESIGN
DESIGN --> SIGNOFF
SIGNOFF -->|Approved| DEVELOPMENT
DEVELOPMENT --> BLOCKERS
BLOCKERS -->|Yes| DESIGN
BLOCKERS -->|No| TESTS
TESTS -->|Yes| PUBLISH
TESTS -->|No| DESIGN
classDef default fill:#e0e0e0,stroke:#666,color:#000
classDef approved fill:#FFF9C4,stroke:#F9A825,color:#000
classDef developed fill:#D5F5D5,stroke:#388E3C,color:#000
classDef blocker fill:#FFCDD2,stroke:#D32F2F,color:#000
classDef notes fill:#E3F2FD,stroke:#1976D2,color:#000
classDef outside fill:#D5F5D5,stroke:#388E3C,stroke-dasharray:5 5,color:#000
class CHECK_DIAGRAM,CREATE,CLAIM,ERROR,SIGNOFF,DESIGN,DEVELOPMENT,BLOCKERS,CHECK_CONTRACT,OPEN,CLARIFY,TRIGGER developed
class PUBLISH,TESTS outside
1️⃣ Wrapper auto-injects title + phase badge + CSS on first load and watches for change of phase on badge.
2️⃣ More than one diagram confuses system. For now, only one per md in order to run.
3️⃣ Checks and publication depend on what and where final product goes, so it's user discretion.
Numbered Notes (1️⃣ 2️⃣ 3️⃣)
When to use:
Pre-execution (design phase):
- Questions that need discussion
- Trade-offs that need decisions
- Unclear requirements
During execution:
- Errors AI can't resolve alone
- Permission needed (destructive action, cost implications)
- Ambiguity in implementation
Format:
### 1️⃣ [Component Name] - [Issue Title]
**Question/Error:** ...
**Context:** ...
**Options:** A, B, C
**Needed:** Decision / Permission / Help
Notes without numbers = just explanations, turn yellow when approved.
Localhost Trigger
Trigger: "lets diagram [PATH]"
Assumes: File at PATH already has mermaid diagram.
Action:
- Start localhost server (port 8080)
- Open browser with diagram
Example:
User: "lets diagram epic-notes/webhook-contract.md"
AI executes:
cd ~/Documents/skills/contract-diagram/engine
./serve.sh &
open "http://localhost:8080/?md=../../epic-notes/webhook-contract.md"
Hot reload enabled by default (2s interval).
- 确保已安装 OpenClaw(本地或 Docker 部署)
- 在对话框中输入安装命令:
/install contract-diagram - 安装完成后,直接呼叫该 Skill 的名称或使用
/contract-diagram触发 - 根据 Skill 的参数说明提供必要输入,即可获得结构化输出
contract diagram 是什么?
Diagram as contract for agreed-upon AI development. 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件,目前累计下载 740 次。
如何安装 contract diagram?
在 OpenClaw 或 Claude Code 对话框中运行命令「/install contract-diagram」即可一键安装,无需额外配置。
contract diagram 是免费的吗?
是的,contract diagram 完全免费(开源免费),可自由下载、安装和使用。
contract diagram 支持哪些平台?
contract diagram 跨平台运行,可在任意部署了 OpenClaw / Claude Code 的环境中使用(cross-platform)。
谁开发了 contract diagram?
由 Nicholas Frota(@nonlinear)开发并维护,当前版本 v1.0.1。