oh-my-design-cli 1.7.0 → 1.7.2
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/.claude/hooks/lib/preferences-parser.cjs +82 -0
- package/.claude/hooks/post-edit-watch.cjs +15 -7
- package/.claude/hooks/session-end-foldin.cjs +11 -14
- package/.claude/hooks/session-state-loader.cjs +3 -2
- package/.claude/hooks/skill-activation.cjs +40 -7
- package/README.ja.md +32 -103
- package/README.ko.md +46 -226
- package/README.md +33 -151
- package/README.zh-TW.md +32 -103
- package/agents/omd-master.md +7 -1
- package/dist/bin/oh-my-design.js +3 -3
- package/dist/bin/oh-my-design.js.map +1 -1
- package/dist/{install-skills-YYHEC4CS.js → install-skills-KDW74C5K.js} +140 -12
- package/dist/install-skills-KDW74C5K.js.map +1 -0
- package/package.json +2 -1
- package/skills/omd-harness/SKILL.md +22 -8
- package/skills/omd-init/SKILL.md +51 -1
- package/skills/omd-reference-capture/SKILL.md +10 -3
- package/dist/install-skills-YYHEC4CS.js.map +0 -1
package/README.ko.md
CHANGED
|
@@ -5,11 +5,7 @@
|
|
|
5
5
|
<h1 align="center">oh-my-design</h1>
|
|
6
6
|
|
|
7
7
|
<p align="center">
|
|
8
|
-
<strong>
|
|
9
|
-
</p>
|
|
10
|
-
|
|
11
|
-
<p align="center">
|
|
12
|
-
<strong>이제 OmD v0.1 Philosophy Layer까지.</strong> Voice · Narrative · Principles · Personas · States · Motion — Claude Code가 AI의 디폴트가 아니라 당신의 브랜드에 맞춰 출력합니다.
|
|
8
|
+
<strong>AI 코딩 에이전트를 위한 스킬 기반 디자인 부트스트랩 — 명령어 한 번.</strong> 221개 실제 기업 디자인 시스템. 설치에 AI 호출 없음. 그 다음은 에이전트에게 말만 하면 됩니다.
|
|
13
9
|
</p>
|
|
14
10
|
|
|
15
11
|
<p align="center">
|
|
@@ -17,8 +13,8 @@
|
|
|
17
13
|
<a href="https://www.npmjs.com/package/oh-my-design-cli"><img src="https://img.shields.io/npm/dm/oh-my-design-cli?style=flat-square&color=cb3837" alt="npm downloads" /></a>
|
|
18
14
|
<a href="LICENSE"><img src="https://img.shields.io/github/license/kwakseongjae/oh-my-design?style=flat-square" alt="License" /></a>
|
|
19
15
|
<a href="https://github.com/kwakseongjae/oh-my-design/stargazers"><img src="https://img.shields.io/github/stars/kwakseongjae/oh-my-design?style=social" alt="GitHub Stars" /></a>
|
|
20
|
-
<img src="https://img.shields.io/badge/references-
|
|
21
|
-
<img src="https://img.shields.io/badge/
|
|
16
|
+
<img src="https://img.shields.io/badge/references-221-7c5cfc?style=flat-square" alt="221 References" />
|
|
17
|
+
<img src="https://img.shields.io/badge/CLI%20commands-1-blue?style=flat-square" alt="One CLI command" />
|
|
22
18
|
</p>
|
|
23
19
|
|
|
24
20
|
<p align="center">
|
|
@@ -27,266 +23,90 @@
|
|
|
27
23
|
|
|
28
24
|
---
|
|
29
25
|
|
|
30
|
-
## oh-my-design
|
|
31
|
-
|
|
32
|
-
**oh-my-design (OmD)** 은 AI 코딩 에이전트에게 "브랜드로서의" UI를 만들어낼 만큼의 컨텍스트를 제공하는 오픈 스펙입니다.
|
|
33
|
-
|
|
34
|
-
[Google이 제안한](https://stitch.withgoogle.com/docs/design-md/overview/) `DESIGN.md`는 본질적으로 **토큰 문서**입니다 — 색상, 타이포, 컴포넌트. 필요하지만 충분하진 않죠. 토큰만으로 UI를 만들면 형태는 그럴싸하지만 "누구의 브랜드"도 아닙니다 — Inter-on-white, 보라색 그라디언트, 의미 없는 이모지 같은 AI의 디폴트로 수렴합니다. OmD v0.1은 그 위에 **브랜드 철학 레이어**를 얹습니다: **Voice · Narrative · Principles · Personas · States · Motion**. OmD 포맷의 `DESIGN.md`를 프로젝트 루트에 두면 에이전트의 결과물이 제네릭하지 않고 "당신의 것"이 됩니다.
|
|
35
|
-
|
|
36
|
-
세 가지 구성:
|
|
37
|
-
|
|
38
|
-
1. **[스펙](spec/omd-v0.1.md)** — 버전 관리되는 Google Stitch 확장, MIT 라이선스.
|
|
39
|
-
2. **[Claude Code 스킬](.claude/skills/omd/SKILL.md)** — 스펙을 하드 제약으로 자동 적용.
|
|
40
|
-
3. **[107개 레퍼런스](references/)** — 실제 기업의 `DESIGN.md` 파일들을 포크하고, 빌더로 커스터마이징해 바로 씁니다.
|
|
41
|
-
|
|
42
|
-
**API 키 불필요. AI 호출 없음. 모두 클라이언트 사이드.**
|
|
26
|
+
## oh-my-design이란?
|
|
43
27
|
|
|
44
|
-
|
|
28
|
+
**oh-my-design (OmD)** 은 AI 코딩 에이전트를 위한 디자인 시스템입니다. Claude Code / Codex / OpenCode / Cursor를 당신의 브랜드를 기억하는 시니어 프로덕트 디자이너로 만듭니다. 한 번 설치하면, 이후엔 원하는 것을 설명하기만 하면 됩니다 — 컴포넌트, 화면, 카피, 에셋, 차트 — 에이전트가 프로젝트의 디자인 시스템을 적용해 결과물을 만들어냅니다. `DESIGN.md`가 브랜드 스펙이고([Google Stitch](https://stitch.withgoogle.com/docs/design-md/overview/) 토큰 + 브랜드 철학 레이어: Voice / Narrative / Principles / Personas / States / Motion), 221개 실제 기업의 DESIGN.md 파일이 패키지에 함께 들어 있습니다. **API 키 불필요. 외부 인프라 불필요. 모든 것이 기존 CLI 세션 안에서 동작합니다.**
|
|
45
29
|
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
**설치 없이 (권장):**
|
|
30
|
+
## 설치
|
|
49
31
|
|
|
50
32
|
```bash
|
|
51
|
-
cd my-project
|
|
52
|
-
|
|
53
|
-
# 1. 한 번만: 에이전트 스킬 설치 (.claude/skills, .codex/skills, .opencode/agents)
|
|
54
33
|
npx oh-my-design-cli install-skills
|
|
34
|
+
```
|
|
55
35
|
|
|
56
|
-
|
|
57
|
-
# (Claude Code/Codex/OpenCode 안에서 omd:init 스킬이 이 단계를 주도)
|
|
58
|
-
npx oh-my-design-cli init recommend "warm approachable B2C marketplace"
|
|
59
|
-
npx oh-my-design-cli init prepare --ref airbnb --description "warm approachable B2C marketplace"
|
|
60
|
-
|
|
61
|
-
# 3. 4개 에이전트가 DESIGN.md를 읽도록 shim 파일 생성/갱신
|
|
62
|
-
npx oh-my-design-cli sync
|
|
63
|
-
|
|
64
|
-
# 4. 작업 중 에이전트가 디자인 선택을 잘못하면 즉시 기록
|
|
65
|
-
npx oh-my-design-cli remember "CTAs are never uppercase"
|
|
36
|
+
설치 후 에이전트를 재시작하세요 (Claude Code는 Cmd+Q 후 재실행) — 새 스킬 + 에이전트가 로드됩니다.
|
|
66
37
|
|
|
67
|
-
|
|
68
|
-
npx oh-my-design-cli learn # pending 보기
|
|
69
|
-
npx oh-my-design-cli learn --mark-applied <id> # 반영 완료 표시
|
|
70
|
-
```
|
|
38
|
+
이것이 당신이 실행할 유일한 CLI 명령어입니다. 나머지는 전부 에이전트에게 자연어로 말하면 됩니다.
|
|
71
39
|
|
|
72
|
-
|
|
40
|
+
설치 시 **어디에** 설치할지 묻습니다: **Project** (`./.claude/skills` — 이 프로젝트만, 기본값) 또는 **Global** (`~/.claude/skills` — 모든 프로젝트; 스킬 + 서브에이전트, 전역 hooks/settings는 건드리지 않음). `--global` 플래그로 프롬프트를 건너뛸 수 있습니다.
|
|
73
41
|
|
|
74
|
-
|
|
75
|
-
npm install -g oh-my-design-cli
|
|
76
|
-
# 이제 'oh-my-design' 또는 단축 별칭 'omd' 사용 가능
|
|
77
|
-
omd install-skills
|
|
78
|
-
omd sync
|
|
79
|
-
omd remember "..."
|
|
80
|
-
```
|
|
42
|
+
## 첫 60초
|
|
81
43
|
|
|
82
|
-
|
|
44
|
+
이게 핵심입니다: 프롬프트 한 줄이 에이전트가 모든 미래 세션에서 기억하는 `DESIGN.md`가 됩니다.
|
|
83
45
|
|
|
84
|
-
|
|
46
|
+
1. 설치(위) 후 **에이전트 재시작** (Cmd+Q, 재실행) — 새 스킬이 로드됩니다.
|
|
85
47
|
|
|
86
|
-
|
|
87
|
-
|---|---|---|
|
|
88
|
-
| `DESIGN.md` | 사용자 | 단일 진실 — 브랜드 & UI 명세 |
|
|
89
|
-
| `CLAUDE.md` | `omd sync` | Claude Code 포인터 (`@./DESIGN.md`) |
|
|
90
|
-
| `AGENTS.md` | `omd sync` | Codex CLI **+** OpenCode 공용 포인터 (한 파일이 둘 커버) |
|
|
91
|
-
| `.cursor/rules/omd-design.mdc` | `omd sync` | Cursor가 UI 파일 편집 시 DESIGN.md 자동 attach |
|
|
92
|
-
| `.claude/skills/omd-*/SKILL.md` | `omd install-skills` | Claude Code 스킬 9종 |
|
|
93
|
-
| `.codex/skills/omd-*/SKILL.md` | `omd install-skills` | Codex 스킬 9종 |
|
|
94
|
-
| `.opencode/agents/omd-*.md` | `omd install-skills` | OpenCode 에이전트 9종 |
|
|
95
|
-
| `.omd/preferences.md` | `omd remember` | append-only 디자인 교정 로그 |
|
|
96
|
-
| `.omd/sync.lock.json` | `omd sync` | drift 감지 상태 |
|
|
48
|
+
2. 프로젝트에서 첫 프롬프트를 입력하세요 — 그대로 복사해도 됩니다:
|
|
97
49
|
|
|
98
|
-
|
|
50
|
+
> Set up our design system — Toss-style, for a family meal-tracking app.
|
|
99
51
|
|
|
100
|
-
|
|
52
|
+
에이전트가 **`omd:init`** 을 실행합니다: 221개 실제 기업 카탈로그에서 레퍼런스를 추천하고, 확인을 받은 뒤 프로젝트 루트에 **`DESIGN.md`** 를 작성합니다. (`omd:sync`가 `CLAUDE.md` / `AGENTS.md` / Cursor shim까지 연결해 모든 에이전트가 자동으로 읽게 합니다.)
|
|
101
53
|
|
|
102
|
-
|
|
54
|
+
**그 `DESIGN.md`가 활성화 지점입니다 — 이제 에이전트가 당신의 브랜드를 기억합니다.**
|
|
103
55
|
|
|
104
|
-
|
|
105
|
-
|---|---|---|
|
|
106
|
-
| `omd:init` | "DESIGN.md 만들어줘" / "브랜드 세팅" | 레퍼런스 추천 → 프로젝트 description 수집 → 레퍼런스 톤·매너 preserve하면서 deltas 반영한 Hybrid variation → DESIGN.md + shim 작성 |
|
|
107
|
-
| `omd:apply` | UI / 스타일링 / 마이크로카피 / 모션 작업 | DESIGN.md + pending preference를 authoritative context로 주입, 사용자 교정 시 자동으로 `omd:remember` 호출 |
|
|
108
|
-
| `omd:harness` | "랜딩 처음부터 / 그럴싸한 랜딩 / 프로토타입 구색 갖춰 / production-ready" | 10-phase 디자인 파이프라인. **v1.6.0** — 자연어 트리거 확대 (슬래시 없이도 발동), **CTX-PRIME** 사전 분석 (~20ms) + 단일 페르소나 picker + Interview-lite 배치로 `omd-master`가 slot-gate 건너뛰고 PROPOSE_PLAN 직행. rule 9 hero archetype 7종 (center-text / carousel / split-screen / editorial / dashboard / quote-led / left-character) 중 brand vibe 매칭으로 선택. rule 5 워드마크-only 로고, rule 10 reveal safety net. |
|
|
109
|
-
| `omd:sync` | "shim drift" / "AGENTS.md 동기화" | 적절한 플래그로 `omd:sync` 실행 |
|
|
110
|
-
| `omd:remember` | "기억해 둬" / "우리는 ~안 해" | 구조화된 entry를 `.omd/preferences.md`에 append |
|
|
111
|
-
| `omd:learn` | "preferences 정리해서 DESIGN.md에 반영" | scope별로 그룹핑 → coherent edit 제안 → status flip |
|
|
56
|
+
3. 이제 그 위에서 빌드하세요:
|
|
112
57
|
|
|
113
|
-
|
|
58
|
+
> Design the home screen.
|
|
114
59
|
|
|
115
|
-
|
|
116
|
-
|---|---|---|
|
|
117
|
-
| `omd:reference-capture` | "X 라이브 자료 가져와" / "에셋 캡쳐" | 라이브 brand 사이트 CDP/playwright inspect → `assets/_reference/<id>/`에 tokens.json + structure.json + fonts.json + `.live-inspect-proof.json` + screenshots + LICENSE-NOTE 작성. Phase 3.9 browser-harness fast-path (3-5x 빠름) auto-detect. |
|
|
118
|
-
| `omd:asset-fetch` | "에셋 가져와줘" / "플레이스홀더 진짜 이미지로" | Free-license 카탈로그 — DiceBear (CC0 avatars), Lucide (ISC icons), Picsum/Loremflickr (CC photos), Bricolage Grotesque / Space Grotesk / DM Serif Display 등 SIL OFL display fonts. 핸드드로잉 캐릭터 SVG 금지. |
|
|
119
|
-
| `omd:experiment-gallery` | "결과물 한 번에 보여줘" / "갤러리 만들어" | N개 experiment 디렉토리를 받아 단일 index.html에 iframe scaled로 비교 뷰 생성. wow rating + archetype badge + round-별 deltas + IP audit 한 카드에. |
|
|
60
|
+
에이전트가 `DESIGN.md`를 읽고 브랜드에 맞는 UI를 만듭니다. 디자인 시스템을 다시 설명할 일은 없습니다.
|
|
120
61
|
|
|
121
|
-
|
|
62
|
+
Toss가 아니어도 됩니다 — `Stripe-style`, `Linear-clone B2B SaaS`, `Karrot-style marketplace` 전부 가능. 전체 카탈로그: [oh-my-design.kr/design-systems](https://oh-my-design.kr/design-systems).
|
|
122
63
|
|
|
123
|
-
|
|
64
|
+
## 지원 에이전트
|
|
124
65
|
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
omd
|
|
131
|
-
omd reference show <id> # 레퍼런스 DESIGN.md를 stdout으로 출력
|
|
132
|
-
omd sync [--force | --check] # shim 파일 작성 또는 감사
|
|
133
|
-
omd remember <note> [--scope ...] # preference entry append
|
|
134
|
-
omd learn # pending 목록
|
|
135
|
-
omd learn --mark-applied <id> # DESIGN.md 반영 후 상태 변경
|
|
136
|
-
omd learn --mark-rejected <id> --reason <text>
|
|
137
|
-
```
|
|
66
|
+
| 에이전트 | 채널 | 설치되는 것 |
|
|
67
|
+
|---|---|---|
|
|
68
|
+
| **Claude Code** | `--agent claude-code` (기본) | 풀 번들 — `.claude/` 아래 스킬, 16 서브에이전트, hooks, data |
|
|
69
|
+
| **Codex** | `--agent codex` | `.agents/skills/` 스킬 번들 (공식 discovery 경로) |
|
|
70
|
+
| **OpenCode** | `--agent opencode` | `.opencode/skills/` 스킬 번들 |
|
|
71
|
+
| **Cursor** | `--agent cursor` | 정식 rules 채널 — `.cursor/rules/omd-design.mdc` shim + 공용 `.claude/data` 카탈로그 (스킬/훅 미설치) |
|
|
138
72
|
|
|
139
|
-
|
|
73
|
+
기본 설치는 감지된 모든 에이전트를 대상으로 합니다; 단일 채널만 원하면 `--agent <name>`.
|
|
140
74
|
|
|
141
|
-
|
|
75
|
+
## 패키지 구성
|
|
142
76
|
|
|
143
|
-
|
|
144
|
-
|---|---|---|
|
|
145
|
-
| 레퍼런스 추천 | CLI (tag + stem 매칭 + category-prior + MMR 다양화) | 빠름, API 키 불필요. category-prior가 도메인 정렬된 ref 가산 (e.g. "marketplace / family / subscription" → Consumer). |
|
|
146
|
-
| Token delta 계산 | CLI (41 키워드 + ~75 synonym controlled vocabulary, additive 합성 + clamp) | 결정적; 동일 description → 동일 delta_set |
|
|
147
|
-
| Color hex shift baseline | CLI (`apply-delta-stub`) — **color-only** | 빠른 결정적 프리뷰. radius / letter-spacing / spacing 은 shift 안 함 — 에이전트 영역. |
|
|
148
|
-
| 전체 토큰 적용 + 섹션 구조 보존 + voice 재작성 | **에이전트** (Claude Code / Codex / OpenCode) + `omd:init` 스킬 | Stub은 color-only; 전체 delta 적용은 구조화된 Markdown 편집 필요. 스킬 프롬프트가 voice fingerprint preservation 강제. |
|
|
149
|
-
| §11–13 (Brand Narrative / Principles / Personas) | **에이전트 + 사용자 입력** (Phase 4.5) | 레퍼런스 content가 프로젝트별 사실 정보 (창립년도, verbatim tagline, 실제 personas). 스킬이 Phase 4.5에서 사실 수집하거나 `[FILL IN: …]` placeholder + `omd:limitation` 코멘트 — 절대 fabricate 안 함. |
|
|
77
|
+
**16 스킬 · 16 서브에이전트 · 221 검증된 레퍼런스 · 활성화 hooks** — 위 명령어 하나로 전부 설치됩니다.
|
|
150
78
|
|
|
151
|
-
|
|
79
|
+
- **스킬** — core flow (`omd:init` / `omd:apply` / `omd:harness` / `omd:sync` / `omd:remember` / `omd:learn`), 라이브 캡처 + 에셋 (`omd:reference-capture` / `omd:asset-fetch` / `omd:experiment-gallery`), v0.2 agent layer (`omd:orchestrator` / `omd:kr-writer` / `omd:locale-adapter` / `omd:designer-review` / `omd:final-qa` / `omd:codex-image`), 그리고 터미널에서 claude.ai/design을 구동하는 단독 스킬 `claude-design`.
|
|
80
|
+
- **서브에이전트** — `omd-master` + 15 스페셜리스트 (UX 리서치, UI 생성, 에셋 큐레이션, 마이크로카피, a11y 감사, 페르소나 테스트, 비평, …).
|
|
81
|
+
- **레퍼런스** — 221개 실제 기업 `DESIGN.md`, 전부 라이브 소스 대조 검증. 모든 레퍼런스는 `oh-my-design.kr/design-systems/<id>.md`에서 raw markdown으로도 제공되어 에이전트가 직접 fetch할 수 있습니다.
|
|
82
|
+
- **Hooks** — UserPromptSubmit / SessionStart / PostToolUse 활성화 — 슬래시 명령 없이 자연어만으로 스킬이 발동합니다.
|
|
152
83
|
|
|
153
|
-
|
|
84
|
+
스킬·에이전트별 상세 레퍼런스: **[oh-my-design.kr/docs](https://oh-my-design.kr/docs)**.
|
|
154
85
|
|
|
155
|
-
|
|
86
|
+
MCP를 선호한다면 **[oh-my-design-mcp](./packages/mcp/)** — 같은 카탈로그를 Claude Desktop, Cursor, Cline, Continue, Codex용 MCP 리소스/툴로 노출합니다. [`packages/mcp/README.md`](./packages/mcp/README.md) 참고.
|
|
156
87
|
|
|
157
|
-
|
|
88
|
+
## 업그레이드
|
|
158
89
|
|
|
159
90
|
```bash
|
|
160
91
|
npx oh-my-design-cli@latest install-skills
|
|
161
92
|
```
|
|
162
93
|
|
|
163
|
-
Idempotent.
|
|
164
|
-
|
|
165
|
-
재실행 후 에이전트 재시작 (Cmd+Q in Claude Code → 재실행) — 새 스킬·에이전트 로드.
|
|
166
|
-
|
|
167
|
-
**버전 확인:**
|
|
94
|
+
Idempotent. `<!-- omd:installed-skill -->` 마커가 있는 관리 파일은 in-place 갱신, 사용자가 수정한 파일은 그대로 둡니다 (`skipped-drift`) — 덮어쓰려면 `--force`. 재실행 후 에이전트 재시작.
|
|
168
95
|
|
|
169
96
|
```bash
|
|
170
97
|
npx oh-my-design-cli --version # 프로젝트에 깔린 버전
|
|
171
98
|
npm view oh-my-design-cli version # npm registry 최신
|
|
172
99
|
```
|
|
173
100
|
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
## OmD v0.1 Philosophy Layer
|
|
177
|
-
|
|
178
|
-
Google Stitch의 9개 섹션 위에 OmD가 더하는 6개:
|
|
179
|
-
|
|
180
|
-
| 섹션 | 역할 |
|
|
181
|
-
|---|---|
|
|
182
|
-
| **10. Voice & Tone** | 마이크로카피 제약 — 버튼 문구, 에러 메시지, 온보딩 |
|
|
183
|
-
| **11. Brand Narrative** | "왜" — 브랜드가 거부하는 것, 바꾸려는 카테고리 |
|
|
184
|
-
| **12. Principles** | 토큰으로 못 푸는 케이스를 결정짓는 5~10개의 1차 원리 |
|
|
185
|
-
| **13. Personas** | 2~4명의 구체 사용자. 에이전트가 UI를 실제 사용 맥락에 grounded 하게 만들기 위함 |
|
|
186
|
-
| **14. States** | Empty / loading / error / skeleton 패턴 — "No data found" 같은 제네릭 상태 방지 |
|
|
187
|
-
| **15. Motion & Easing** | Named duration + easing 토큰 — Stitch 9개 섹션이 놓치는 차원 |
|
|
188
|
-
|
|
189
|
-
**현재 10개 레퍼런스가 완전한 Philosophy Layer와 함께 제공됩니다:**
|
|
190
|
-
Toss · Claude · Line · Stripe · Linear · Vercel · Notion · Airbnb · Apple · Figma — 각각 voice, narrative, principles, personas, states, motion까지 공개 출처 기반으로 작성됐습니다.
|
|
191
|
-
|
|
192
|
-
전체 OmD v0.1 예시는 [references/toss/DESIGN.md](references/toss/DESIGN.md) 참고.
|
|
193
|
-
|
|
194
|
-
## 주요 구성
|
|
195
|
-
|
|
196
|
-
- **빌더** — 레퍼런스 선택 후 색상 / radius / 다크 모드를 조정하고, 컴포넌트를 고른 뒤 Export. **Philosophy** 필터로 완전한 브랜드 철학을 담은 10개만 볼 수 있어요.
|
|
197
|
-
- **디자인 시스템 디렉토리** ([oh-my-design.kr/design-systems](https://oh-my-design.kr/design-systems)) — 107개 레퍼런스 중 34개는 공식 디자인 시스템 또는 브랜드 가이드라인 페이지가 있으며, 디렉토리에서 라이브 썸네일과 함께 바로 이동할 수 있습니다.
|
|
198
|
-
- **Personal Curation** ([oh-my-design.kr/curation](https://oh-my-design.kr/curation)) — MBTI 스타일의 짧은 퀴즈로 당신의 디자인 성향을 107개 레퍼런스 중 하나와 매칭해, 해당 레퍼런스가 미리 선택된 빌더로 바로 이동시켜 줍니다.
|
|
199
|
-
|
|
200
|
-
## claude-design — 터미널에서 claude.ai/design 구동 (단독 스킬)
|
|
201
|
-
|
|
202
|
-
코드베이스(스택·디자인 토큰·컴포넌트·실제 UI 카피·브랜드 에셋)를 분석해 **claude.ai/design** 을 끝까지 자동 구동하고, 코드 기반으로 생성된 디자인의 공유 링크를 돌려주는 Claude Code 전용 스킬입니다. 생성 전 claude.ai/design 이 명확화 질문을 띄우면, 스킬이 질문을 읽고 **코드 맥락에 맞는 답을 직접 선택**합니다(애매하면 "Decide for me" 폴백).
|
|
203
|
-
|
|
204
|
-
omd 툴체인 없이 단독 설치:
|
|
205
|
-
|
|
206
|
-
```bash
|
|
207
|
-
npx oh-my-design-cli install-skills --skills claude-design --agent claude-code --skills-only
|
|
208
|
-
# 모든 프로젝트에서 한 번만 쓰려면 --global (이 프로젝트 대신 ~/.claude/skills 에 설치):
|
|
209
|
-
npx oh-my-design-cli install-skills --skills claude-design --agent claude-code --skills-only --global
|
|
210
|
-
```
|
|
211
|
-
|
|
212
|
-
(설치 시 **스코프 선택** — Project `./.claude/skills`(기본) vs Global `~/.claude/skills`(모든 프로젝트, hooks/settings는 안 건드림). `--global` 로 프롬프트 생략.) Claude Code 재시작 후 `/claude-design` (또는 "이 랜딩 디자인 만들어줘"처럼 자연어로). 요구사항: Claude Code(Chrome 자동화 + `python3` + 전역 `playwright` 필요), 스킬이 여는 창에서 claude.ai 1회 로그인. `x-omd-channels` 로 채널 제한 — Codex/OpenCode 타깃은 건너뜁니다.
|
|
213
|
-
|
|
214
|
-
## 107개 지원 레퍼런스
|
|
215
|
-
|
|
216
|
-
| 카테고리 | 기업 |
|
|
217
|
-
|----------|------|
|
|
218
|
-
| **AI & LLM** | Claude, Cohere, ElevenLabs, Minimax, Mistral AI, Ollama, OpenCode AI, Replicate, RunwayML, Together AI, VoltAgent, xAI |
|
|
219
|
-
| **디자인 도구** | Airtable, Clay, Figma, Framer, Miro, Webflow |
|
|
220
|
-
| **개발자 도구** | Cursor, Expo, Lovable, Raycast, Superhuman, Vercel, Warp |
|
|
221
|
-
| **생산성** | Cal.com, freee, Intercom, Linear, Mintlify, Notion, Resend, Zapier |
|
|
222
|
-
| **컨슈머 테크** | Airbnb, Apple, Baemin, Dcard, IBM, Kakao, Karrot, LINE, Mercari, NVIDIA, Pinkoi, Pinterest, SpaceX, Spotify, Uber |
|
|
223
|
-
| **핀테크** | Coinbase, Kraken, Revolut, Stripe, Toss, Wise |
|
|
224
|
-
| **백엔드 & DevOps** | ClickHouse, Composio, Hashicorp, MongoDB, PostHog, Sanity, Sentry, Supabase |
|
|
225
|
-
| **자동차** | BMW, Ferrari, Lamborghini, Renault, Tesla |
|
|
226
|
-
| **마케팅** | Semrush |
|
|
227
|
-
|
|
228
|
-
> 빌더의 **국가 필터**로 지역별 탐색이 가능합니다 (한국, 대만, 일본, 프랑스, 이탈리아, 독일, 영국, 미국).
|
|
229
|
-
|
|
230
|
-
## 내보내는 DESIGN.md
|
|
231
|
-
|
|
232
|
-
[Google Stitch DESIGN.md 포맷](https://stitch.withgoogle.com/docs/design-md/overview/) 기반 — 섹션 1~9 + OmD v0.1 Philosophy Layer(섹션 10~15, 선택):
|
|
233
|
-
|
|
234
|
-
**베이스 (Google Stitch)**
|
|
235
|
-
1. Visual Theme & Atmosphere
|
|
236
|
-
2. Color Palette & Roles
|
|
237
|
-
3. Typography Rules
|
|
238
|
-
4. Component Stylings
|
|
239
|
-
5. Layout Principles
|
|
240
|
-
6. Depth & Elevation
|
|
241
|
-
7. Do's and Don'ts
|
|
242
|
-
8. Responsive Behavior
|
|
243
|
-
9. Agent Prompt Guide
|
|
244
|
-
|
|
245
|
-
**OmD v0.1 Philosophy Layer (추가)**
|
|
246
|
-
|
|
247
|
-
10. Voice & Tone
|
|
248
|
-
11. Brand Narrative
|
|
249
|
-
12. Principles
|
|
250
|
-
13. Personas
|
|
251
|
-
14. States
|
|
252
|
-
15. Motion & Easing
|
|
253
|
-
|
|
254
|
-
그 외: Style Preferences, Included Components, Iconography & SVG Guidelines, Document Policies.
|
|
255
|
-
|
|
256
|
-
## 프로젝트 구조
|
|
257
|
-
|
|
258
|
-
```
|
|
259
|
-
oh-my-design/
|
|
260
|
-
spec/ OmD v0.1 스펙 (정본)
|
|
261
|
-
.claude/skills/omd/ Claude Code 스킬 번들
|
|
262
|
-
references/ 107개 기업 DESIGN.md 파일
|
|
263
|
-
src/ CLI 코어 (TypeScript)
|
|
264
|
-
web/ Next.js 웹 빌더
|
|
265
|
-
src/app/ Landing + Builder + Directory 페이지
|
|
266
|
-
src/components/ Wizard, Preview, Export
|
|
267
|
-
test/ CLI Vitest 스위트 (unit/, integration/, scripts/)
|
|
268
|
-
```
|
|
269
|
-
|
|
270
|
-
웹 테스트는 소스 파일 옆에 함께 위치합니다 (`web/src/**/*.test.ts`).
|
|
271
|
-
|
|
272
|
-
## 테스트
|
|
273
|
-
|
|
274
|
-
두 개의 스위트가 있고, 둘 다 Vitest로 돌아가며 둘 다 통과해야 합니다:
|
|
275
|
-
|
|
276
|
-
```bash
|
|
277
|
-
npm test # CLI: 370 테스트 — unit + 레퍼런스 전체 smoke
|
|
278
|
-
cd web && npm test # Web: 88 테스트 — generate-css, config-hash, survey
|
|
279
|
-
```
|
|
280
|
-
|
|
281
|
-
통합 스위트(`test/integration/all-references.test.ts`)는 모든 `references/<id>/DESIGN.md`에 대해 전체 생성 파이프라인을 실행합니다. 망가진 레퍼런스가 있으면 PR 리뷰에서 어떤 ref의 어떤 체크가 실패했는지 한눈에 보입니다. 폴더 컨벤션과 모듈별 커버리지 맵은 [test/README.md](test/README.md)를 참고하세요.
|
|
282
|
-
|
|
283
|
-
## 감사의 글
|
|
101
|
+
릴리스별 변경 사항 — re-install 이상이 필요한 변경 포함 — 은 [CHANGELOG.md](./CHANGELOG.md)에 있습니다.
|
|
284
102
|
|
|
285
|
-
|
|
286
|
-
- [kzhrknt/awesome-design-md-jp](https://github.com/kzhrknt/awesome-design-md-jp) — 일본 시장 디자인 시스템 레퍼런스.
|
|
103
|
+
## 링크
|
|
287
104
|
|
|
288
|
-
oh-my-design
|
|
105
|
+
- **카탈로그** — [oh-my-design.kr/design-systems](https://oh-my-design.kr/design-systems) (모든 레퍼런스 + 에이전트용 raw `.md` twin)
|
|
106
|
+
- **컬렉션** — [oh-my-design.kr/collections](https://oh-my-design.kr/collections) (유스케이스별 큐레이션)
|
|
107
|
+
- **문서** — [oh-my-design.kr/docs](https://oh-my-design.kr/docs) (설치 옵션, 스킬, 에이전트, FAQ)
|
|
108
|
+
- **체인지로그** — [CHANGELOG.md](CHANGELOG.md) · 0.1.x에서 마이그레이션: [MIGRATION.md](MIGRATION.md)
|
|
289
109
|
|
|
290
110
|
## 라이선스
|
|
291
111
|
|
|
292
|
-
[
|
|
112
|
+
MIT — [LICENSE](LICENSE) 참고. 레퍼런스는 각 기업의 자산이며, 교육적 참조 목적으로만 재구성되었습니다.
|
package/README.md
CHANGED
|
@@ -17,15 +17,15 @@
|
|
|
17
17
|
<img src="https://img.shields.io/badge/CLI%20commands-1-blue?style=flat-square" alt="One CLI command" />
|
|
18
18
|
</p>
|
|
19
19
|
|
|
20
|
+
<p align="center">
|
|
21
|
+
English | <a href="README.ko.md">한국어</a> | <a href="README.ja.md">日本語</a> | <a href="README.zh-TW.md">繁體中文</a>
|
|
22
|
+
</p>
|
|
23
|
+
|
|
20
24
|
---
|
|
21
25
|
|
|
22
26
|
## What is oh-my-design?
|
|
23
27
|
|
|
24
|
-
**oh-my-design (OmD)**
|
|
25
|
-
|
|
26
|
-
`DESIGN.md` is the brand spec ([Google Stitch](https://stitch.withgoogle.com/docs/design-md/overview/) tokens + the brand-philosophy layer: Voice / Narrative / Principles / Personas / States / Motion). 221 real-company DESIGN.md files ship in this package. Pick one, customize through conversation, ship.
|
|
27
|
-
|
|
28
|
-
**No API keys. No external infra. Everything runs inside your existing CLI session.**
|
|
28
|
+
**oh-my-design (OmD)** is a design system for AI coding agents. It turns Claude Code / Codex / OpenCode / Cursor into a senior product designer with a working memory of your brand. You install once. After that, you just describe what you want — components, screens, copy, assets, charts — and the agent applies your project's design system and ships. `DESIGN.md` is the brand spec ([Google Stitch](https://stitch.withgoogle.com/docs/design-md/overview/) tokens + a brand-philosophy layer: Voice / Narrative / Principles / Personas / States / Motion), and 221 real-company DESIGN.md files ship in this package. **No API keys. No external infra. Everything runs inside your existing CLI session.**
|
|
29
29
|
|
|
30
30
|
## Install
|
|
31
31
|
|
|
@@ -61,169 +61,51 @@ This is the whole point: one prompt turns into a `DESIGN.md` your agent remember
|
|
|
61
61
|
|
|
62
62
|
Don't want Toss? Any brand works — `Stripe-style`, `Linear-clone B2B SaaS`, `Karrot-style marketplace`. Browse the full catalog at [oh-my-design.kr/design-systems](https://oh-my-design.kr/design-systems).
|
|
63
63
|
|
|
64
|
-
##
|
|
65
|
-
|
|
66
|
-
Skills and agents evolve every release. To pick up the latest bundle in an existing project:
|
|
67
|
-
|
|
68
|
-
```bash
|
|
69
|
-
npx oh-my-design-cli@latest install-skills
|
|
70
|
-
```
|
|
64
|
+
## Supported agents
|
|
71
65
|
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
**
|
|
77
|
-
|
|
78
|
-
```bash
|
|
79
|
-
npx oh-my-design-cli --version # what your project currently uses
|
|
80
|
-
npm view oh-my-design-cli version # latest on the registry
|
|
81
|
-
```
|
|
82
|
-
|
|
83
|
-
**What's new each release:** [CHANGELOG.md](./CHANGELOG.md). Every release entry says what changed in the skills, agents, hooks, CLI, and data. If a change requires anything beyond a re-install — for example a migration of `DESIGN.md` frontmatter — it will be called out at the top of that entry.
|
|
84
|
-
|
|
85
|
-
### v0.2 agent layer (bundled)
|
|
66
|
+
| Agent | Channel | What gets installed |
|
|
67
|
+
|---|---|---|
|
|
68
|
+
| **Claude Code** | `--agent claude-code` (default) | Full bundle — skills, 16 sub-agents, hooks, data under `.claude/` |
|
|
69
|
+
| **Codex** | `--agent codex` | Skill bundle at `.agents/skills/` (official discovery path) |
|
|
70
|
+
| **OpenCode** | `--agent opencode` | Skill bundle at `.opencode/skills/` |
|
|
71
|
+
| **Cursor** | `--agent cursor` | First-class rules channel — `.cursor/rules/omd-design.mdc` shim + the shared `.claude/data` catalog (no skills/hooks) |
|
|
86
72
|
|
|
87
|
-
|
|
73
|
+
The default install targets every detected agent; pass `--agent <name>` to install a single channel.
|
|
88
74
|
|
|
89
|
-
|
|
90
|
-
|---|---|
|
|
91
|
-
| `omd-orchestrator` | Supervisor — 5-stage workflow (write → review → revise → localize → critic → images → handoff), 2-round revision cap |
|
|
92
|
-
| `omd-kr-writer` | Korean prose, **12 voice presets** (toss-tech-design default / karrot-neighborly / brunch-maker / naver-d2 / …) |
|
|
93
|
-
| `omd-locale-adapter` | KR → EN/JP/ZH-TW **adaptation** (cultural swaps, not literal translation) |
|
|
94
|
-
| `omd-designer-review` | Visual + brand audit vs DESIGN.md — typo/color/radius/state, BLOCK·WARN·FYI |
|
|
95
|
-
| `omd-final-qa` | 8-item rubric, read-only verdict, no rubber-stamps |
|
|
96
|
-
| `omd-codex-image` | Channel-aware image materialization — `<!-- omd:gen-image -->` spec → **Codex native generation** / `omd-asset-curator` fallback / OpenCode user-queue |
|
|
75
|
+
## What's inside
|
|
97
76
|
|
|
98
|
-
|
|
77
|
+
**16 skills · 16 sub-agents · 221 verified references · activation hooks** — installed by the one command above.
|
|
99
78
|
|
|
100
|
-
|
|
79
|
+
- **Skills** — core flow (`omd:init` / `omd:apply` / `omd:harness` / `omd:sync` / `omd:remember` / `omd:learn`), live capture + assets (`omd:reference-capture` / `omd:asset-fetch` / `omd:experiment-gallery`), the v0.2 agent layer (`omd:orchestrator` / `omd:kr-writer` / `omd:locale-adapter` / `omd:designer-review` / `omd:final-qa` / `omd:codex-image`), plus the standalone `claude-design` skill that drives claude.ai/design from your terminal.
|
|
80
|
+
- **Sub-agents** — `omd-master` + 15 specialists (UX research, UI generation, asset curation, microcopy, a11y audit, persona testing, critique, …).
|
|
81
|
+
- **References** — 221 real-company `DESIGN.md` files, each verified against live sources. Every reference is also served as raw markdown at `oh-my-design.kr/design-systems/<id>.md`, so agents can fetch it directly.
|
|
82
|
+
- **Hooks** — UserPromptSubmit / SessionStart / PostToolUse activation so the skills trigger on natural language, not just slash commands.
|
|
101
83
|
|
|
102
|
-
|
|
84
|
+
Full skill-by-skill and agent-by-agent reference: **[oh-my-design.kr/docs](https://oh-my-design.kr/docs)**.
|
|
103
85
|
|
|
104
|
-
|
|
86
|
+
Prefer MCP? **[oh-my-design-mcp](./packages/mcp/)** exposes the same catalog as MCP resources/tools for Claude Desktop, Cursor, Cline, Continue, and Codex — see [`packages/mcp/README.md`](./packages/mcp/README.md).
|
|
105
87
|
|
|
106
|
-
|
|
88
|
+
## Upgrading
|
|
107
89
|
|
|
108
90
|
```bash
|
|
109
|
-
npx oh-my-design-cli install-skills
|
|
110
|
-
# add --global to install once for EVERY project (~/.claude/skills) instead of this one:
|
|
111
|
-
npx oh-my-design-cli install-skills --skills claude-design --agent claude-code --skills-only --global
|
|
91
|
+
npx oh-my-design-cli@latest install-skills
|
|
112
92
|
```
|
|
113
93
|
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
## How to use omd with your AI
|
|
117
|
-
|
|
118
|
-
Open Claude Code (or Codex / OpenCode) in your project. Just talk:
|
|
119
|
-
|
|
120
|
-
> "Set up the design system for a calm B2B fintech dashboard."
|
|
121
|
-
> Agent picks a reference from the catalog (likely Linear or Stripe), proposes a hybrid DESIGN.md, asks for confirmation, writes the file plus shims.
|
|
122
|
-
|
|
123
|
-
> "Make the empty-state for the search results page."
|
|
124
|
-
> Agent reads DESIGN.md, builds the component with brand tokens, picks an inline SVG illustration matching the voice, drops in microcopy that follows the §10 voice rules.
|
|
94
|
+
Idempotent. Managed files (those carrying the `<!-- omd:installed-skill -->` marker) are refreshed in place; files you edited are left untouched (`skipped-drift`) unless you pass `--force`. Restart your agent after re-running.
|
|
125
95
|
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
> "Add a daily-intake line chart."
|
|
130
|
-
> Agent reads your `package.json`, sees `recharts` is installed, builds the chart with brand colors, no library mismatch.
|
|
131
|
-
|
|
132
|
-
> "We never use uppercase CTAs."
|
|
133
|
-
> Agent silently appends to `.omd/preferences.md`. Next time anyone makes a CTA, that rule applies. Later you can say "fold preferences into DESIGN.md" and the agent merges by scope.
|
|
134
|
-
|
|
135
|
-
## What's in the install
|
|
136
|
-
|
|
137
|
-
| Path | Owner | Purpose |
|
|
138
|
-
|---|---|---|
|
|
139
|
-
| `.claude/skills/omd-*/SKILL.md` | install-skills | Claude Code skill bundle (15 skills — core flow + capture/assets + v0.2 agent layer) |
|
|
140
|
-
| `.agents/skills/omd-*/SKILL.md` | install-skills | Codex skill bundle (official `.agents/skills` discovery path) |
|
|
141
|
-
| `.opencode/skills/omd-*/SKILL.md` | install-skills | OpenCode skill bundle |
|
|
142
|
-
| `.claude/agents/omd-*.md` | install-skills | 16 canonical sub-agents (master + 15 specialists) |
|
|
143
|
-
| `.claude/data/*` | install-skills | reference fingerprints, vocabulary, opt-out corpus |
|
|
144
|
-
| `.claude/hooks/*.cjs` | install-skills | UserPromptSubmit / SessionStart / PostToolUse hooks |
|
|
145
|
-
| `.claude/skills/skill-rules.json` | install-skills | Skill activation rules |
|
|
146
|
-
| `references/*/DESIGN.md` | bundled | 221 real design systems |
|
|
147
|
-
| `DESIGN.md` | your agent (after init flow) | Your project's authoritative brand spec |
|
|
148
|
-
| `CLAUDE.md` / `AGENTS.md` / `.cursor/rules/omd-design.mdc` | omd-sync skill | Pointers so every agent reads DESIGN.md |
|
|
149
|
-
| `.omd/preferences.md` | omd-remember skill | Append-only design correction log |
|
|
150
|
-
| `.omd/runs/<id>/` | omd-harness skill | Per-harness-run artifacts (briefs, wireframes, eval, handoff zips) |
|
|
151
|
-
|
|
152
|
-
## The 15 skills + 16 agents
|
|
153
|
-
|
|
154
|
-
Skills (loaded into your agent's context based on prompt triggers):
|
|
155
|
-
|
|
156
|
-
**Core flow**
|
|
157
|
-
- **omd:apply** — DESIGN.md as authoritative context for every UI task. Routes complex requests (assets, charts, full screens, a11y audit) to specialized sub-agents.
|
|
158
|
-
- **omd:init** — Bootstrap DESIGN.md from a reference + project description. 221 references, hybrid variation that preserves the reference voice while shifting only user-named axes.
|
|
159
|
-
- **omd:harness** — `/omd-harness <task>` to run the 10-phase design pipeline. **v1.6.0**: auto-triggers on natural-language requests ("그럴싸한 랜딩 만들어줘", "프로토타입 구색 갖춰") — no slash required. New **CTX-PRIME** pre-phase scans your repo (stack, brand color, voice, surface inventory) in ~20ms, then surfaces a single audience picker + batched Interview-lite so `omd-master` skips slot-gate and jumps straight to PROPOSE_PLAN. 7 hero archetypes (rule 9) match brand vibe to layout (center-text / carousel / split-screen / editorial / dashboard / quote-led / left-character). Reveal safety net (rule 10), wordmark-only logo (rule 5), container-inner consistency (rule 7), decomposed hero (rule 8).
|
|
160
|
-
- **omd:remember** — Captures user corrections to `.omd/preferences.md` automatically when the agent detects them.
|
|
161
|
-
- **omd:learn** — Folds pending corrections back into DESIGN.md by scope.
|
|
162
|
-
- **omd:sync** — Maintains the shim files (CLAUDE.md / AGENTS.md / Cursor mdc) so every agent reads your DESIGN.md.
|
|
163
|
-
|
|
164
|
-
**Live capture + assets** (v1.3.x)
|
|
165
|
-
- **omd:reference-capture** — Live brand site CDP/playwright inspect → `assets/_reference/<id>/` with tokens.json + structure.json + fonts.json + `.live-inspect-proof.json` + screenshots + LICENSE-NOTE/attribution. Phase 3.9 browser-harness fast-path: 3-5× faster than playwright MCP when available.
|
|
166
|
-
- **omd:asset-fetch** — Free-license asset catalog with verified URLs. DiceBear CC0 (notionists/lorelei avatars), Lucide ISC icons, Picsum CC0 / Loremflickr Flickr-CC photos, SIL OFL display fonts (Bricolage Grotesque / Space Grotesk / DM Serif Display / Fraunces). Strict anti-patterns: handcrafted character SVG forbidden, brand creative work never in product DOM.
|
|
167
|
-
- **omd:experiment-gallery** — N-brand experiment results in a single comparison index.html. iframe scaled previews + wow ratings + multi-turn deltas + per-brand IP audit. Reusable across batches.
|
|
168
|
-
|
|
169
|
-
**v0.2 agent layer** (6 more) — `omd:orchestrator` / `omd:kr-writer` / `omd:locale-adapter` / `omd:designer-review` / `omd:final-qa` / `omd:codex-image`. See the [v0.2 agent layer](#v02-agent-layer-bundled) table above for what each does.
|
|
170
|
-
|
|
171
|
-
Sub-agents — master + 15 specialists (invoked by the master or directly by skills):
|
|
172
|
-
|
|
173
|
-
- **omd-master** — Conversational state machine, runs the harness phases. opus.
|
|
174
|
-
- **omd-ux-researcher** — Reads bundled references, validates Tier-1 official design system URLs. opus.
|
|
175
|
-
- **omd-ui-junior** — Generates wireframes and component manifests from DESIGN.md. sonnet.
|
|
176
|
-
- **omd-ux-engineer** — Section-level interaction / motion / IA / mobile / perceived-perf audit + code-level fixes. NN/g heuristics + Refactoring UI + Web Vitals + WAI-ARIA. Senior advisor; pairs with `omd-ui-junior` (generator). opus.
|
|
177
|
-
- **omd-asset-curator** — Picks asset medium (inline SVG / chart library / Lottie / Rive / Unsplash), generates inline code or sources external. Stack-aware (recharts vs chartjs vs custom SVG, lucide vs heroicons, etc.). sonnet.
|
|
178
|
-
- **omd-microcopy** — Voice-consistent copy generation tied to DESIGN.md §10. sonnet.
|
|
179
|
-
- **omd-ux-writer** — Section-level copy audit + 2-3 strong alternatives + A/B hypothesis. Podmajersky / Erika Hall / Mailchimp / Stripe / GitHub voice docs integrated. Senior advisor; pairs with `omd-microcopy` (generator). opus.
|
|
180
|
-
- **omd-a11y-auditor** — WCAG checks. haiku.
|
|
181
|
-
- **omd-persona-tester** — Adversarial 4-persona walkthrough (V/J/F/S). sonnet.
|
|
182
|
-
- **omd-critic** — Root-cause analysis when the user iterates. opus.
|
|
183
|
-
|
|
184
|
-
Plus the **6 v0.2 sub-agents** (orchestrator / kr-writer / locale-adapter / designer-review / final-qa / codex-image) — documented in the [v0.2 agent layer](#v02-agent-layer-bundled) section.
|
|
185
|
-
|
|
186
|
-
## MCP server
|
|
187
|
-
|
|
188
|
-
Want the brand DESIGN.md files exposed directly to your agent as MCP resources, tools, and prompts? Use **[oh-my-design-mcp](./packages/mcp/)** — a separate, free, drop-in MCP server.
|
|
189
|
-
|
|
190
|
-
```json
|
|
191
|
-
{
|
|
192
|
-
"mcpServers": {
|
|
193
|
-
"oh-my-design": {
|
|
194
|
-
"command": "npx",
|
|
195
|
-
"args": ["-y", "oh-my-design-mcp"]
|
|
196
|
-
}
|
|
197
|
-
}
|
|
198
|
-
}
|
|
96
|
+
```bash
|
|
97
|
+
npx oh-my-design-cli --version # what your project currently uses
|
|
98
|
+
npm view oh-my-design-cli version # latest on the registry
|
|
199
99
|
```
|
|
200
100
|
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
## What it is not
|
|
204
|
-
|
|
205
|
-
- It is not a collection of CLI commands. There is one bootstrap command. Everything else is skill prose.
|
|
206
|
-
- It is not an SDK. If you need the matching algorithm or shim format, look at the skill markdown directly.
|
|
207
|
-
- It does not generate emojis as icons. Asset agent prefers inline SVG (Lucide-matched or custom).
|
|
208
|
-
|
|
209
|
-
## Repository layout
|
|
210
|
-
|
|
211
|
-
> For contributors. If you're just *using* OmD, you never touch these — the install ships everything you need.
|
|
212
|
-
|
|
213
|
-
The brand `DESIGN.md` corpus lives in more than one place **on purpose**. Here's the map so nothing looks like accidental duplication:
|
|
214
|
-
|
|
215
|
-
| Path | In git? | Ships to npm? | Role |
|
|
216
|
-
|---|---|---|---|
|
|
217
|
-
| `web/references/<id>/DESIGN.md` | ✅ | ✅ (CLI pkg) | **Canonical source of truth.** Lives under `web/` because the Vercel project root is `web/` — the site build can only read files beneath it. Everything else is derived from here. |
|
|
218
|
-
| `references` → `web/references` | ❌ gitignored | — | Local convenience symlink so root-level scripts/tests resolve the same path during local dev. |
|
|
219
|
-
| `design-md/<id>/DESIGN.md` | ✅ | ❌ | Public [awesome-design-md](https://github.com/VoltAgent/awesome-design-md)-style mirror — frontmatter-stripped + a "Source / Last verified" note. A different *format*, not a byte copy. |
|
|
220
|
-
| `packages/mcp/data/references/` | ❌ gitignored | ✅ (MCP pkg) | Build artifact. Regenerated from `web/references` by `packages/mcp/scripts/sync-data.mjs` on every `prepublish`/`build`. Never edit by hand. |
|
|
221
|
-
|
|
222
|
-
**Rule of thumb: edit `web/references/<id>/DESIGN.md` only.** `web/scripts/build-registry.mjs` regenerates the typed registry, and the pre-commit catalog-integrity gate (`web/__tests__/catalog-integrity.test.ts`) plus `sync-data.mjs` keep the derived copies honest.
|
|
101
|
+
What changed each release — including anything that needs more than a re-install — is in [CHANGELOG.md](./CHANGELOG.md).
|
|
223
102
|
|
|
224
|
-
##
|
|
103
|
+
## Links
|
|
225
104
|
|
|
226
|
-
|
|
105
|
+
- **Catalog** — [oh-my-design.kr/design-systems](https://oh-my-design.kr/design-systems) (every reference, with raw `.md` twins for agents)
|
|
106
|
+
- **Collections** — [oh-my-design.kr/collections](https://oh-my-design.kr/collections) (curated sets by use case)
|
|
107
|
+
- **Docs** — [oh-my-design.kr/docs](https://oh-my-design.kr/docs) (install options, skills, agents, FAQ)
|
|
108
|
+
- **Changelog** — [CHANGELOG.md](CHANGELOG.md) · migrating from 0.1.x: [MIGRATION.md](MIGRATION.md)
|
|
227
109
|
|
|
228
110
|
## License
|
|
229
111
|
|