oh-my-design-cli 1.8.7 → 1.9.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.
- package/.claude/hooks/lib/preferences-parser.cjs +1 -0
- package/.claude/hooks/lib/preferences-writer.cjs +1 -0
- package/.claude/hooks/post-edit-watch.cjs +1 -0
- package/.claude/hooks/session-end-foldin.cjs +1 -0
- package/.claude/hooks/session-state-loader.cjs +1 -0
- package/.claude/hooks/skill-activation.cjs +1 -0
- package/.claude/settings.json +10 -1
- package/.github/assets/logo-bg.png +0 -0
- package/AGENTS.md +20 -1
- package/CHANGELOG.md +482 -0
- package/MIGRATION.md +103 -0
- package/README.ja.md +56 -19
- package/README.ko.md +47 -30
- package/README.md +48 -30
- package/README.zh-TW.md +59 -22
- package/agents/AGENT.md +8 -7
- package/agents/omd-codex-image.md +1 -1
- package/agents/omd-critic.md +6 -7
- package/agents/omd-designer-review.md +1 -1
- package/agents/omd-final-qa.md +1 -1
- package/agents/omd-humanizer.md +38 -0
- package/agents/omd-kr-writer.md +3 -4
- package/agents/omd-locale-adapter.md +12 -16
- package/agents/omd-master.md +24 -19
- package/agents/omd-microcopy.md +1 -1
- package/agents/omd-orchestrator.md +7 -8
- package/agents/omd-slop-auditor.md +31 -0
- package/agents/omd-ux-researcher.md +1 -1
- package/data/reference-fingerprints.json +1995 -38
- package/dist/bin/oh-my-design.js +16 -8
- package/dist/bin/oh-my-design.js.map +1 -1
- package/dist/chunk-UJIHCEYF.js +99 -0
- package/dist/chunk-UJIHCEYF.js.map +1 -0
- package/dist/doctor-LDWSFM3I.js +763 -0
- package/dist/doctor-LDWSFM3I.js.map +1 -0
- package/dist/install-skills-ZZFNJ2II.js +1120 -0
- package/dist/install-skills-ZZFNJ2II.js.map +1 -0
- package/docs/CLI_QUICKSTART.md +157 -0
- package/package.json +25 -4
- package/scripts/postinstall.cjs +5 -4
- package/skills/claude-design/SKILL.md +38 -14
- package/skills/claude-design/references/claude-design-flow.md +11 -11
- package/skills/claude-design/references/codebase-analysis.md +5 -4
- package/skills/omd-final-qa/SKILL.md +1 -1
- package/skills/omd-harness/SKILL.md +51 -50
- package/skills/omd-humanize/SKILL.md +116 -0
- package/skills/omd-humanize/agents/openai.yaml +4 -0
- package/skills/omd-humanize/references/locale-playbooks.md +102 -0
- package/skills/omd-humanize/references/sources.md +11 -0
- package/skills/omd-init/SKILL.md +18 -12
- package/skills/omd-locale-adapter/SKILL.md +58 -91
- package/skills/omd-orchestrator/SKILL.md +11 -5
- package/skills/omd-reference-capture/SKILL.md +80 -26
- package/skills/omd-reference-capture/scripts/PLAYWRIGHT-LICENSE.txt +202 -0
- package/skills/omd-reference-capture/scripts/PLAYWRIGHT-NOTICE.txt +5 -0
- package/skills/omd-reference-capture/scripts/THIRD_PARTY_NOTICES.md +3 -0
- package/skills/omd-reference-capture/scripts/capture-reference-evidence.mjs +159906 -0
- package/skills/omd-slop-audit/SKILL.md +110 -0
- package/skills/omd-slop-audit/agents/openai.yaml +4 -0
- package/skills/omd-slop-audit/references/pattern-catalog.md +96 -0
- package/skills/omd-slop-audit/references/sources.md +24 -0
- package/web/references/104/DESIGN.md +354 -0
- package/web/references/11st/DESIGN.md +197 -316
- package/web/references/29cm/DESIGN.md +297 -393
- package/web/references/42dot/DESIGN.md +390 -0
- package/web/references/8percent/DESIGN.md +438 -0
- package/web/references/ably/DESIGN.md +267 -572
- package/web/references/acer/DESIGN.md +329 -0
- package/web/references/airbnb/DESIGN.md +219 -557
- package/web/references/alipay/DESIGN.md +179 -420
- package/web/references/apple/DESIGN.md +224 -498
- package/web/references/asleep/DESIGN.md +402 -0
- package/web/references/au/DESIGN.md +334 -0
- package/web/references/autopedia/DESIGN.md +382 -0
- package/web/references/aws-cloudscape/DESIGN.md +241 -0
- package/web/references/baemin/DESIGN.md +332 -491
- package/web/references/banksalad/DESIGN.md +269 -180
- package/web/references/barogo/DESIGN.md +416 -0
- package/web/references/beusable/DESIGN.md +464 -0
- package/web/references/bilibili/DESIGN.md +206 -374
- package/web/references/bmw/DESIGN.md +162 -276
- package/web/references/brandi/DESIGN.md +184 -325
- package/web/references/catchtable/DESIGN.md +219 -264
- package/web/references/cgv/DESIGN.md +317 -0
- package/web/references/channeltalk/DESIGN.md +210 -336
- package/web/references/china-airlines/DESIGN.md +291 -0
- package/web/references/cjonstyle/DESIGN.md +453 -0
- package/web/references/class101/DESIGN.md +168 -387
- package/web/references/classum/DESIGN.md +228 -203
- package/web/references/claude/DESIGN.md +242 -479
- package/web/references/clay/DESIGN.md +179 -377
- package/web/references/clickhouse/DESIGN.md +254 -343
- package/web/references/cohere/DESIGN.md +214 -324
- package/web/references/coinone/DESIGN.md +199 -179
- package/web/references/corca/DESIGN.md +414 -0
- package/web/references/coupang/DESIGN.md +205 -475
- package/web/references/cursor/DESIGN.md +240 -381
- package/web/references/dabang/DESIGN.md +248 -213
- package/web/references/dable/DESIGN.md +431 -0
- package/web/references/datarize/DESIGN.md +217 -330
- package/web/references/dealicious/DESIGN.md +402 -0
- package/web/references/drdiary/DESIGN.md +404 -0
- package/web/references/elastic/DESIGN.md +238 -0
- package/web/references/elevenlabs/DESIGN.md +183 -321
- package/web/references/eslite/DESIGN.md +257 -0
- package/web/references/evaair/DESIGN.md +338 -0
- package/web/references/expo/DESIGN.md +238 -331
- package/web/references/familymart-tw/DESIGN.md +254 -0
- package/web/references/ferrari/DESIGN.md +160 -377
- package/web/references/figma/DESIGN.md +197 -451
- package/web/references/fitpet/DESIGN.md +445 -0
- package/web/references/flex/DESIGN.md +170 -253
- package/web/references/framer/DESIGN.md +197 -340
- package/web/references/freee/DESIGN.md +211 -533
- package/web/references/friendliai/DESIGN.md +431 -0
- package/web/references/frip/DESIGN.md +440 -0
- package/web/references/gangnamunni/DESIGN.md +154 -591
- package/web/references/gaudiolab/DESIGN.md +414 -0
- package/web/references/google/DESIGN.md +290 -398
- package/web/references/hashicorp/DESIGN.md +273 -318
- package/web/references/heydealer/DESIGN.md +429 -0
- package/web/references/humanscape/DESIGN.md +433 -0
- package/web/references/hyundai/DESIGN.md +158 -368
- package/web/references/hyundaicard/DESIGN.md +171 -121
- package/web/references/ibm/DESIGN.md +227 -378
- package/web/references/idus/DESIGN.md +450 -0
- package/web/references/igaworks/DESIGN.md +437 -0
- package/web/references/inflearn/DESIGN.md +221 -366
- package/web/references/intuit/DESIGN.md +244 -0
- package/web/references/jandi/DESIGN.md +191 -291
- package/web/references/jobplanet/DESIGN.md +415 -0
- package/web/references/kakao/DESIGN.md +287 -475
- package/web/references/kakaobank/DESIGN.md +220 -521
- package/web/references/kakaogames/DESIGN.md +220 -0
- package/web/references/kakaopay/DESIGN.md +207 -526
- package/web/references/karrot/DESIGN.md +227 -251
- package/web/references/kb-kookmin/DESIGN.md +308 -0
- package/web/references/kbank/DESIGN.md +220 -175
- package/web/references/kmong/DESIGN.md +281 -356
- package/web/references/krds/DESIGN.md +245 -19
- package/web/references/kream/DESIGN.md +224 -359
- package/web/references/kurly/DESIGN.md +211 -533
- package/web/references/lamborghini/DESIGN.md +198 -360
- package/web/references/lguplus/DESIGN.md +259 -0
- package/web/references/likelion/DESIGN.md +283 -0
- package/web/references/line/DESIGN.md +396 -355
- package/web/references/linear.app/DESIGN.md +209 -562
- package/web/references/lotteon/DESIGN.md +386 -0
- package/web/references/lovable/DESIGN.md +255 -349
- package/web/references/makinarocks/DESIGN.md +149 -349
- package/web/references/maum-ai/DESIGN.md +423 -0
- package/web/references/medibloc/DESIGN.md +425 -0
- package/web/references/megabox/DESIGN.md +232 -0
- package/web/references/mercari/DESIGN.md +217 -434
- package/web/references/microsoft/DESIGN.md +234 -388
- package/web/references/mildang/DESIGN.md +411 -0
- package/web/references/millie/DESIGN.md +183 -504
- package/web/references/minimax/DESIGN.md +264 -322
- package/web/references/miricanvas/DESIGN.md +182 -355
- package/web/references/miro/DESIGN.md +234 -232
- package/web/references/mistral.ai/DESIGN.md +231 -314
- package/web/references/mixi/DESIGN.md +234 -0
- package/web/references/moin/DESIGN.md +445 -0
- package/web/references/mongodb/DESIGN.md +219 -316
- package/web/references/musinsa/DESIGN.md +184 -510
- package/web/references/mynavi/DESIGN.md +242 -0
- package/web/references/myrealtrip/DESIGN.md +169 -406
- package/web/references/naver/DESIGN.md +328 -499
- package/web/references/naverwebtoon/DESIGN.md +172 -395
- package/web/references/nhn/DESIGN.md +169 -346
- package/web/references/nhncloud/DESIGN.md +185 -123
- package/web/references/notion/DESIGN.md +271 -475
- package/web/references/nrise/DESIGN.md +417 -0
- package/web/references/ohouse/DESIGN.md +210 -549
- package/web/references/oliveyoung/DESIGN.md +217 -326
- package/web/references/ollama/DESIGN.md +241 -308
- package/web/references/onestore/DESIGN.md +248 -0
- package/web/references/palantir/DESIGN.md +256 -0
- package/web/references/panasonic/DESIGN.md +276 -0
- package/web/references/patternfly/DESIGN.md +259 -0
- package/web/references/payhere/DESIGN.md +438 -0
- package/web/references/pega/DESIGN.md +262 -0
- package/web/references/peoplefund/DESIGN.md +431 -0
- package/web/references/petfriends/DESIGN.md +428 -0
- package/web/references/pinkfong/DESIGN.md +199 -367
- package/web/references/pinterest/DESIGN.md +258 -308
- package/web/references/poya/DESIGN.md +286 -0
- package/web/references/pozalabs/DESIGN.md +438 -0
- package/web/references/protopie/DESIGN.md +419 -0
- package/web/references/qraft/DESIGN.md +448 -0
- package/web/references/quotabook/DESIGN.md +449 -0
- package/web/references/recruit/DESIGN.md +247 -0
- package/web/references/remember/DESIGN.md +202 -396
- package/web/references/resend/DESIGN.md +274 -348
- package/web/references/sakura-internet/DESIGN.md +269 -0
- package/web/references/samsung/DESIGN.md +157 -359
- package/web/references/sandoll/DESIGN.md +445 -0
- package/web/references/sanity/DESIGN.md +241 -375
- package/web/references/scatterlab/DESIGN.md +412 -0
- package/web/references/selectstar/DESIGN.md +439 -0
- package/web/references/servicenow/DESIGN.md +289 -0
- package/web/references/shinhanbank/DESIGN.md +161 -341
- package/web/references/shinhancard/DESIGN.md +208 -319
- package/web/references/sionic/DESIGN.md +454 -0
- package/web/references/sktelecom/DESIGN.md +310 -0
- package/web/references/socar/DESIGN.md +125 -32
- package/web/references/softbank/DESIGN.md +231 -0
- package/web/references/sony/DESIGN.md +234 -0
- package/web/references/soop/DESIGN.md +261 -0
- package/web/references/spacex/DESIGN.md +184 -323
- package/web/references/spotify/DESIGN.md +253 -394
- package/web/references/squeezebits/DESIGN.md +441 -0
- package/web/references/stayfolio/DESIGN.md +422 -0
- package/web/references/stripe/DESIGN.md +212 -491
- package/web/references/supabase/DESIGN.md +244 -316
- package/web/references/tabling/DESIGN.md +415 -0
- package/web/references/taishinbank/DESIGN.md +243 -0
- package/web/references/teamlab/DESIGN.md +240 -0
- package/web/references/teamsparta/DESIGN.md +472 -0
- package/web/references/tellingme/DESIGN.md +392 -0
- package/web/references/tesla/DESIGN.md +244 -427
- package/web/references/thsr/DESIGN.md +284 -0
- package/web/references/thumbtack/DESIGN.md +302 -0
- package/web/references/together.ai/DESIGN.md +257 -304
- package/web/references/toss/DESIGN.md +251 -593
- package/web/references/toss-securities/DESIGN.md +255 -178
- package/web/references/tossbank/DESIGN.md +195 -491
- package/web/references/toyota/DESIGN.md +238 -0
- package/web/references/tving/DESIGN.md +197 -245
- package/web/references/typed/DESIGN.md +413 -0
- package/web/references/uber/DESIGN.md +256 -333
- package/web/references/udn/DESIGN.md +250 -0
- package/web/references/upbit/DESIGN.md +145 -256
- package/web/references/upstage/DESIGN.md +211 -204
- package/web/references/uswds/DESIGN.md +287 -0
- package/web/references/vercel/DESIGN.md +236 -440
- package/web/references/wanted/DESIGN.md +215 -487
- package/web/references/wise/DESIGN.md +223 -231
- package/web/references/wisetracker/DESIGN.md +462 -0
- package/web/references/wooribank/DESIGN.md +245 -0
- package/web/references/yanolja/DESIGN.md +250 -419
- package/web/references/yeogiotte/DESIGN.md +235 -418
- package/web/references/zapier/DESIGN.md +256 -377
- package/web/references/zendesk/DESIGN.md +288 -0
- package/web/references/zigzag/DESIGN.md +200 -621
- package/dist/install-skills-7UUDOLG2.js +0 -734
- package/dist/install-skills-7UUDOLG2.js.map +0 -1
package/MIGRATION.md
ADDED
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
# MIGRATION — 0.1.x → 1.9.x
|
|
2
|
+
|
|
3
|
+
The current release is a skill-driven, bin-only package. The CLI installs and diagnoses the OmD bundle; design work happens through natural-language prompts inside your coding agent. It ships 20 skills, 18 specialist roles, and a local catalog of 440+ `DESIGN.md` references.
|
|
4
|
+
|
|
5
|
+
This guide is for projects that used `oh-my-design-cli` 0.1.x. Existing project `DESIGN.md`, `.omd/preferences.md`, and `.omd/runs/` files remain useful; do not delete them.
|
|
6
|
+
|
|
7
|
+
## Upgrade each project
|
|
8
|
+
|
|
9
|
+
From the project root:
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npx oh-my-design-cli@latest
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Choose the project-local channels you actually use, restart those coding agents, and verify the installed files:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npx oh-my-design-cli@latest doctor
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
`doctor` reports the real channel paths, catalog/fingerprint coverage, specialist roles, hooks, and whether the project has a root `DESIGN.md`. If it finds an incomplete managed install, run the exact repair command it prints and then run `doctor` again. A stale managed Claude hook is repaired with the targeted `--repair-hooks` flag; unrelated unmarked files remain untouched.
|
|
22
|
+
|
|
23
|
+
For a user-level Claude Code, Codex, or OpenCode installation, use `install-skills --global` and verify it with `doctor --global`. Cursor rules are intentionally project-scoped and reject `--global`.
|
|
24
|
+
|
|
25
|
+
## The important break
|
|
26
|
+
|
|
27
|
+
The 0.1.x operational CLI commands were removed in 1.0.0. The supported CLI surface is now:
|
|
28
|
+
|
|
29
|
+
- `npx oh-my-design-cli@latest` — guided installer;
|
|
30
|
+
- `npx oh-my-design-cli@latest install-skills ...` — explicit/non-interactive installation; and
|
|
31
|
+
- `npx oh-my-design-cli@latest doctor` — health check and scoped repair instruction.
|
|
32
|
+
|
|
33
|
+
The package no longer exposes a programmatic TypeScript API. Code that imported `oh-my-design-cli` must migrate to the installed markdown skills/data or invoke the bin as an installer/doctor.
|
|
34
|
+
|
|
35
|
+
## 0.1.x command map
|
|
36
|
+
|
|
37
|
+
The following prompt-based replacements apply to **Claude Code, Codex, and OpenCode**, where OmD skills are installed:
|
|
38
|
+
|
|
39
|
+
| Removed 0.1.x command | Current workflow |
|
|
40
|
+
|---|---|
|
|
41
|
+
| `omd init recommend "..."` | Ask: `Set up our design system — Linear-style, for a B2B operations dashboard.` The agent uses `omd:init`, recommends a reference, asks for confirmation, and writes root `DESIGN.md`. |
|
|
42
|
+
| `omd init prepare --ref vercel ...` | Ask: `Create our DESIGN.md using Vercel as the reference; keep unverified facts absent.` |
|
|
43
|
+
| `omd remember "..."` | Say the correction naturally, for example: `Remember this preference: cards use borders, not decorative shadows.` The `omd:remember` skill records it. |
|
|
44
|
+
| `omd learn` | Ask: `Fold confirmed preferences into DESIGN.md.` The `omd:learn` skill presents the proposal before changing the system. |
|
|
45
|
+
| `omd sync` | Ask: `Sync DESIGN.md into the agent instruction shims.` The `omd:sync` skill updates managed blocks. |
|
|
46
|
+
| `omd harness "..."` | Run `/omd-harness <task>` or ask for the full OmD design harness. Mandatory user checkpoints remain in place. |
|
|
47
|
+
| `omd generate` | Removed. Create/download `DESIGN.md` in the [Builder](https://oh-my-design.kr/builder), or ask a skill-enabled agent to set it up. |
|
|
48
|
+
| `omd preview` | Removed. Ask the coding agent to build and open the actual product route. |
|
|
49
|
+
| `omd reference list/show` | Browse the [reference catalog](https://oh-my-design.kr/design-systems), read an installed channel catalog, or fetch `https://oh-my-design.kr/<id>/design.md`. |
|
|
50
|
+
| `omd context --internal` | Context discovery is part of the installed skills/harness. The deterministic helper remains bundled for internal skill use. |
|
|
51
|
+
| `omd setup-blender` | Removed from the public CLI. Asset workflows guide optional tooling only when it is actually needed. |
|
|
52
|
+
|
|
53
|
+
## Channel capabilities and paths
|
|
54
|
+
|
|
55
|
+
| Channel | Project installation | What can run |
|
|
56
|
+
|---|---|---|
|
|
57
|
+
| Claude Code | `.claude/{skills,agents,data}/` plus managed project hooks/settings | 20 skills, 18 specialist roles, local catalog |
|
|
58
|
+
| Codex | `.agents/skills/`, `.codex/agents/`, `.codex/data/` | 20 skills, 18 embedded specialist-role definitions, local catalog; the project must be trusted |
|
|
59
|
+
| OpenCode | `.opencode/{skills,agents,data}/` | 20 skills, 18 native agents, local catalog |
|
|
60
|
+
| Cursor | `.cursor/rules/omd-design.mdc` plus `.claude/data/` | One project rule and the local catalog; **no OmD skills or sub-agents** |
|
|
61
|
+
|
|
62
|
+
Codex's old OmD-managed `.codex/skills/` entrypoints are retired. A current reinstall migrates installer-owned files to `.agents/skills/` while preserving private, unowned files. OpenCode now uses its native `skills`, `agents`, and `data` directories.
|
|
63
|
+
|
|
64
|
+
### Cursor migration is different
|
|
65
|
+
|
|
66
|
+
Do not ask Cursor to run `omd:init`, `omd:feel`, or `/omd-harness`: the Cursor channel does not install those skills or specialist roles.
|
|
67
|
+
|
|
68
|
+
Use one of these supported paths instead:
|
|
69
|
+
|
|
70
|
+
1. Select/customize a reference in the [Builder](https://oh-my-design.kr/builder), download `DESIGN.md`, and save it at the project root; or
|
|
71
|
+
2. ask Cursor explicitly:
|
|
72
|
+
|
|
73
|
+
```text
|
|
74
|
+
Read .claude/data/references/toss/DESIGN.md and create a root DESIGN.md
|
|
75
|
+
for this product using confirmed values only. Keep unknown facts absent.
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
Then ask Cursor to build against `@DESIGN.md`. The installed rule's contract is intentionally small: read root `DESIGN.md` before UI work, apply pending `.omd/preferences.md` corrections, and use framework defaults only after those two sources.
|
|
79
|
+
|
|
80
|
+
## Managed upgrades and local edits
|
|
81
|
+
|
|
82
|
+
Current installs are idempotent:
|
|
83
|
+
|
|
84
|
+
- installer-owned skills, roles, catalog entries, and hooks carry managed markers/hashes and refresh when unchanged;
|
|
85
|
+
- same-ID reference edits, private references, and unmarked user files are preserved;
|
|
86
|
+
- retired installer-owned files can be cleaned up without deleting user sidecars;
|
|
87
|
+
- `--repair-hooks` refreshes the managed Claude hook bundle only; and
|
|
88
|
+
- `--force` is an explicit last resort for overwriting drift. Review local edits before using it.
|
|
89
|
+
|
|
90
|
+
After every bundle upgrade, restart the coding agent and run:
|
|
91
|
+
|
|
92
|
+
```bash
|
|
93
|
+
npx oh-my-design-cli@latest doctor
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
## Data retained from 0.1.x
|
|
97
|
+
|
|
98
|
+
- Root `DESIGN.md` remains the authoritative project design specification.
|
|
99
|
+
- `.omd/preferences.md` remains the preference/correction store and should be retained.
|
|
100
|
+
- Existing `.omd/runs/<id>/` directories remain learning artifacts; do not delete them.
|
|
101
|
+
- The npm package is bin-only. The removed `src/index.ts` exports have no replacement public API.
|
|
102
|
+
|
|
103
|
+
For the current first-run flow, see [docs/CLI_QUICKSTART.md](docs/CLI_QUICKSTART.md). For release-by-release changes, see [CHANGELOG.md](CHANGELOG.md).
|
package/README.ja.md
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
<p align="center">
|
|
2
|
-
<img src=".github/assets/logo-bg.png" width="480" alt="oh-my-design" />
|
|
2
|
+
<img src="https://raw.githubusercontent.com/kwakseongjae/oh-my-design/main/.github/assets/logo-bg.png" width="480" alt="oh-my-design" />
|
|
3
3
|
</p>
|
|
4
4
|
|
|
5
5
|
<h1 align="center">oh-my-design</h1>
|
|
6
6
|
|
|
7
7
|
<p align="center">
|
|
8
|
-
<strong>AI
|
|
8
|
+
<strong>AI コーディングエージェントが、プロジェクト専用の DESIGN.md を基準に作業できる環境を整えます。</strong> ガイド付きインストールと doctor、20 の再利用可能なスキル、18 の専門ロール、品質評価済みの企業リファレンス 440 件以上を提供します。ローカルワークフローに別の API キーや MCP サーバーは不要です。
|
|
9
9
|
</p>
|
|
10
10
|
|
|
11
11
|
<p align="center">
|
|
@@ -13,8 +13,8 @@
|
|
|
13
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>
|
|
14
14
|
<a href="LICENSE"><img src="https://img.shields.io/github/license/kwakseongjae/oh-my-design?style=flat-square" alt="License" /></a>
|
|
15
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>
|
|
16
|
-
<img src="https://img.shields.io/badge/references-
|
|
17
|
-
<img src="https://img.shields.io/badge/CLI%
|
|
16
|
+
<img src="https://img.shields.io/badge/references-440%2B-7c5cfc?style=flat-square" alt="440+ References" />
|
|
17
|
+
<img src="https://img.shields.io/badge/CLI-install%20%2B%20doctor-blue?style=flat-square" alt="Install and doctor CLI" />
|
|
18
18
|
</p>
|
|
19
19
|
|
|
20
20
|
<p align="center">
|
|
@@ -25,49 +25,86 @@
|
|
|
25
25
|
|
|
26
26
|
## oh-my-design とは?
|
|
27
27
|
|
|
28
|
-
**oh-my-design (OmD)**
|
|
28
|
+
**oh-my-design (OmD)** は、普段使っている AI コーディングツールにローカルのデザインワークフローを導入します。Claude Code / Codex / OpenCode には再利用可能なスキルと専門ロールを、Cursor には同じ `DESIGN.md` を適用するプロジェクト rule をインストールします。`DESIGN.md` は、[Google Stitch](https://stitch.withgoogle.com/docs/design-md/overview/) のトークンに Voice、Narrative、Principles、Personas、States、Motion を加えた移植可能なブランド仕様です。パッケージには品質と根拠の状態を明示した企業リファレンス 440 件以上も含まれます。**コアのインストールとローカルワークフローに別の API キー、デーモン、MCP サーバーは不要です。推論には既存のコーディングエージェントのセッションを使います。任意の `claude-design` スキルは、Chrome でログイン済みの claude.ai/design セッションを開きます。**
|
|
29
29
|
|
|
30
30
|
## インストール
|
|
31
31
|
|
|
32
32
|
```bash
|
|
33
|
-
npx oh-my-design-cli
|
|
33
|
+
npx oh-my-design-cli@latest
|
|
34
34
|
```
|
|
35
35
|
|
|
36
|
-
インストール後、エージェントを再起動してください (Claude Code は Cmd+Q → 再起動)
|
|
36
|
+
インストール後、エージェントを再起動してください (Claude Code は Cmd+Q → 再起動)。続いて、実際にインストールされたチャネル別ファイルを一度確認します。
|
|
37
37
|
|
|
38
|
-
|
|
38
|
+
```bash
|
|
39
|
+
npx oh-my-design-cli@latest doctor
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
CLI の役割はバンドルの導入と診断までです。その後のデザイン作業はすべてエージェントへの自然言語で進めます。
|
|
43
|
+
|
|
44
|
+
インストール先は **Project** (このリポジトリ内のチャネル別パス、デフォルト) または **Global** (全プロジェクトで使うユーザーパス) から選べます。OpenCode はプロジェクト導入では `.opencode/`、グローバル導入では `~/.config/opencode/` を使用します。グローバルの hooks/settings は変更しません。`npx oh-my-design-cli@latest install-skills --global` で Global を直接選び、`npx oh-my-design-cli@latest doctor --global` で診断できます。
|
|
45
|
+
|
|
46
|
+
## 最初の 60 秒 — Claude Code、Codex、OpenCode
|
|
47
|
+
|
|
48
|
+
インストールから画面で確認できる結果までの最短手順です。
|
|
49
|
+
|
|
50
|
+
1. 上のコマンドでインストールし、**エージェントを再起動**します。続けて `npx oh-my-design-cli@latest doctor` を実行し、チャネル別ファイルを確認します。
|
|
51
|
+
|
|
52
|
+
2. プロジェクトで次のプロンプトを入力します。
|
|
53
|
+
|
|
54
|
+
> 家族向け食事記録アプリの DESIGN.md を作成して。Toss を参考にし、確認済みの値だけを使って、製品固有の内容は決める前に確認して。
|
|
55
|
+
|
|
56
|
+
スキルを読み込んだエージェントが `omd:init` を実行し、リファレンスを提案して確認を取り、プロジェクトルートに `DESIGN.md` を作成します。ファイルはリポジトリに残るため、後のセッションでも同じ判断を読み直せます。
|
|
57
|
+
|
|
58
|
+
3. 作成した仕様を使って画面を作ります。
|
|
59
|
+
|
|
60
|
+
> DESIGN.md を読み、現在の動作とロゴを保ったままホーム画面をデザインして。
|
|
61
|
+
|
|
62
|
+
エージェントは記録済みの判断を基準に作業し、結果をプロジェクト内に残します。
|
|
39
63
|
|
|
40
64
|
## サポートされるエージェント
|
|
41
65
|
|
|
42
66
|
| エージェント | チャネル | インストールされるもの |
|
|
43
67
|
|---|---|---|
|
|
44
|
-
| **Claude Code** | `--agent claude-code` (デフォルト) | フルバンドル — `.claude/` 配下のスキル、
|
|
45
|
-
| **Codex** | `--agent codex` | `.agents/skills/`
|
|
46
|
-
| **OpenCode** | `--agent opencode` | `.opencode/skills/`
|
|
47
|
-
| **Cursor** | `--agent cursor` |
|
|
68
|
+
| **Claude Code** | `--agent claude-code` (デフォルト) | フルバンドル — `.claude/` 配下のスキル、18 サブエージェント、hooks、data |
|
|
69
|
+
| **Codex** | `--agent codex` | `.agents/skills/` のスキル、`.codex/agents/` の埋め込みサブエージェント定義、`.codex/data/` のローカルカタログ |
|
|
70
|
+
| **OpenCode** | `--agent opencode` | Project: `.opencode/{skills,agents,data}/` のスキル・ネイティブのサブエージェント・カタログ。Global: `~/.config/opencode/{skills,agents,data}/` の同じバンドル |
|
|
71
|
+
| **Cursor** | `--agent cursor` | プロジェクト rule `.cursor/rules/omd-design.mdc` + 共有 `.claude/data` カタログ。OmD スキル、サブエージェント、hooks は導入しない |
|
|
72
|
+
|
|
73
|
+
デフォルトでは検出されたすべてのエージェントにインストールします。単一チャネルを非対話で導入するには `npx oh-my-design-cli@latest install-skills --agent <name> --all` を実行します。
|
|
74
|
+
|
|
75
|
+
### Cursor の正しい利用経路
|
|
48
76
|
|
|
49
|
-
|
|
77
|
+
Cursor は rules-only チャネルであり、`omd:init`、`omd:feel`、OmD サブエージェントは実行しません。プロジェクト仕様は次のいずれかで用意します。
|
|
78
|
+
|
|
79
|
+
1. [Builder](https://oh-my-design.kr/builder) でリファレンスを選択・調整し、`DESIGN.md` をダウンロードしてプロジェクトルートに保存する。
|
|
80
|
+
2. Cursor に `Read .claude/data/references/toss/DESIGN.md and create a root DESIGN.md for this product using confirmed values only. Keep unknown facts absent.` と明示的に依頼する。
|
|
81
|
+
|
|
82
|
+
その後、`@DESIGN.md を読み、動作を変えずにホーム画面を再設計して` と依頼します。導入される rule の最小契約は、`DESIGN.md` を最優先し、保留中の `.omd/preferences.md` 修正を次に適用し、フレームワークの既定値を最後に使うことです。
|
|
50
83
|
|
|
51
84
|
## パッケージの中身
|
|
52
85
|
|
|
53
|
-
**
|
|
86
|
+
**20 スキル · 18 サブエージェント · 品質・根拠ステータス付きの 440 件以上のリファレンス · 起動 hooks** がスキル対応チャネルのフルバンドルです。Cursor には意図的に rule とカタログのみを導入します。
|
|
54
87
|
|
|
55
|
-
すべてのリファレンスは `oh-my-design.kr/<id>/design.md` から raw markdown としても取得でき、エージェントが直接 fetch できます。スキル・エージェントごとの詳細リファレンス: **[oh-my-design.kr/docs](https://oh-my-design.kr/docs)**。
|
|
88
|
+
すべてのリファレンスは `oh-my-design.kr/<id>/design.md` から raw markdown としても取得でき、エージェントが直接 fetch できます。スキル・エージェントごとの詳細リファレンス: **[oh-my-design.kr/docs/ja](https://oh-my-design.kr/docs/ja)**。
|
|
56
89
|
|
|
57
90
|
## アップグレード
|
|
58
91
|
|
|
59
92
|
```bash
|
|
60
|
-
npx oh-my-design-cli@latest
|
|
93
|
+
npx oh-my-design-cli@latest
|
|
61
94
|
```
|
|
62
95
|
|
|
63
|
-
|
|
96
|
+
何度実行しても同じ状態に保たれます。OmD のマーカーまたはハッシュが付いた管理ファイルはその場で更新し、ユーザーが編集したファイルは残します。まず `doctor` が表示する対象範囲を限定した修復コマンドを使ってください。管理対象の Claude hook が古い場合は、ほかの未管理ファイルを上書きしない `--repair-hooks` が含まれます。`--force` は意図的なローカル変更を確認した後にだけ使用してください。再インストール後はエージェントを再起動し、もう一度確認します。
|
|
97
|
+
|
|
98
|
+
```bash
|
|
99
|
+
npx oh-my-design-cli@latest doctor
|
|
100
|
+
```
|
|
64
101
|
|
|
65
102
|
## リンク
|
|
66
103
|
|
|
67
104
|
- **カタログ** — [oh-my-design.kr/design-systems](https://oh-my-design.kr/design-systems)
|
|
68
105
|
- **コレクション** — [oh-my-design.kr/collections](https://oh-my-design.kr/collections)
|
|
69
|
-
- **ドキュメント** — [oh-my-design.kr/docs](https://oh-my-design.kr/docs)
|
|
70
|
-
- **チェンジログ** — [CHANGELOG.md](CHANGELOG.md)
|
|
106
|
+
- **ドキュメント** — [oh-my-design.kr/docs/ja](https://oh-my-design.kr/docs/ja)
|
|
107
|
+
- **チェンジログ** — [CHANGELOG.md](CHANGELOG.md) · 0.1.x からの移行: [MIGRATION.md](MIGRATION.md)
|
|
71
108
|
|
|
72
109
|
## ライセンス
|
|
73
110
|
|
package/README.ko.md
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
<p align="center">
|
|
2
|
-
<img src=".github/assets/logo-bg.png" width="480" alt="oh-my-design" />
|
|
2
|
+
<img src="https://raw.githubusercontent.com/kwakseongjae/oh-my-design/main/.github/assets/logo-bg.png" width="480" alt="oh-my-design" />
|
|
3
3
|
</p>
|
|
4
4
|
|
|
5
5
|
<h1 align="center">oh-my-design</h1>
|
|
6
6
|
|
|
7
7
|
<p align="center">
|
|
8
|
-
<strong>AI 코딩
|
|
8
|
+
<strong>AI 코딩 에이전트가 프로젝트의 DESIGN.md를 기준으로 일하게 하세요.</strong> 안내형 설치와 doctor, 재사용 가능한 스킬 20개, 전문 역할 18개, 품질 등급을 매긴 기업 레퍼런스 440개 이상을 함께 제공합니다. 로컬 워크플로에는 별도 API 키나 MCP 서버가 필요 없습니다.
|
|
9
9
|
</p>
|
|
10
10
|
|
|
11
11
|
<p align="center">
|
|
@@ -13,8 +13,8 @@
|
|
|
13
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>
|
|
14
14
|
<a href="LICENSE"><img src="https://img.shields.io/github/license/kwakseongjae/oh-my-design?style=flat-square" alt="License" /></a>
|
|
15
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>
|
|
16
|
-
<img src="https://img.shields.io/badge/references-
|
|
17
|
-
<img src="https://img.shields.io/badge/CLI%
|
|
16
|
+
<img src="https://img.shields.io/badge/references-440%2B-7c5cfc?style=flat-square" alt="440+ References" />
|
|
17
|
+
<img src="https://img.shields.io/badge/CLI-install%20%2B%20doctor-blue?style=flat-square" alt="Install and doctor CLI" />
|
|
18
18
|
</p>
|
|
19
19
|
|
|
20
20
|
<p align="center">
|
|
@@ -25,39 +25,43 @@
|
|
|
25
25
|
|
|
26
26
|
## oh-my-design이란?
|
|
27
27
|
|
|
28
|
-
**oh-my-design (OmD)** 은 AI 코딩
|
|
28
|
+
**oh-my-design (OmD)** 은 지금 쓰는 AI 코딩 도구에 로컬 디자인 워크플로를 설치합니다. Claude Code / Codex / OpenCode에는 재사용 가능한 스킬과 전문 역할을, Cursor에는 같은 `DESIGN.md`를 적용하는 프로젝트 rule을 넣습니다. `DESIGN.md`는 [Google Stitch](https://stitch.withgoogle.com/docs/design-md/overview/) 토큰에 Voice, Narrative, Principles, Personas, States, Motion을 더한 이식 가능한 브랜드 명세입니다. 패키지에는 품질 등급과 근거 상태를 표시한 기업 레퍼런스 440개 이상도 들어 있습니다. **핵심 설치와 로컬 워크플로에는 별도 API 키·데몬·MCP 서버가 필요 없고, 추론은 기존 코딩 에이전트 세션에서 이뤄집니다. 선택 기능인 `claude-design`은 로그인된 Chrome의 claude.ai/design 세션을 엽니다.**
|
|
29
29
|
|
|
30
30
|
## 설치
|
|
31
31
|
|
|
32
32
|
```bash
|
|
33
|
-
npx oh-my-design-cli
|
|
33
|
+
npx oh-my-design-cli@latest
|
|
34
34
|
```
|
|
35
35
|
|
|
36
|
-
설치 후 에이전트를 재시작하세요 (Claude Code는 Cmd+Q 후 재실행)
|
|
36
|
+
설치 후 에이전트를 재시작하세요 (Claude Code는 Cmd+Q 후 재실행). 그런 다음 실제 채널 파일이 정상인지 한 번 진단합니다.
|
|
37
37
|
|
|
38
|
-
|
|
38
|
+
```bash
|
|
39
|
+
npx oh-my-design-cli@latest doctor
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
CLI는 번들을 설치하고 진단하는 역할만 합니다. 이후 디자인 작업은 전부 에이전트에게 자연어로 말하면 됩니다.
|
|
39
43
|
|
|
40
|
-
설치 시 **어디에** 설치할지 묻습니다: **Project** (
|
|
44
|
+
설치 시 **어디에** 설치할지 묻습니다: **Project** (이 저장소의 채널별 경로, 기본값) 또는 **Global** (모든 프로젝트에서 쓰는 사용자 경로). OpenCode는 프로젝트 설치에 `.opencode/`, 전역 설치에 `~/.config/opencode/`를 사용합니다. 전역 hooks/settings는 건드리지 않습니다. `npx oh-my-design-cli@latest install-skills --global`로 전역 범위를 바로 선택한 뒤 `npx oh-my-design-cli@latest doctor --global`로 진단할 수 있습니다.
|
|
41
45
|
|
|
42
|
-
## 첫 60초
|
|
46
|
+
## 첫 60초 — Claude Code, Codex, OpenCode
|
|
43
47
|
|
|
44
|
-
|
|
48
|
+
설치부터 눈으로 확인할 결과까지 가장 짧은 경로입니다.
|
|
45
49
|
|
|
46
50
|
1. 설치(위) 후 **에이전트 재시작** (Cmd+Q, 재실행) — 새 스킬이 로드됩니다.
|
|
47
51
|
|
|
48
52
|
2. 프로젝트에서 첫 프롬프트를 입력하세요 — 그대로 복사해도 됩니다:
|
|
49
53
|
|
|
50
|
-
>
|
|
54
|
+
> 가족 식단 기록 앱의 DESIGN.md를 만들어줘. Toss를 레퍼런스로 쓰되 확인된 값만 가져오고, 제품 고유 정보는 결정하기 전에 물어봐.
|
|
51
55
|
|
|
52
|
-
에이전트가 **`omd:init`** 을
|
|
56
|
+
스킬이 설치된 에이전트가 **`omd:init`** 을 실행합니다. 품질 등급을 매긴 기업 카탈로그 440개 이상에서 레퍼런스를 추천하고, 확인을 받은 뒤 프로젝트 루트에 **`DESIGN.md`** 를 작성합니다. (`omd:sync`로 관리되는 에이전트 지침 shim도 갱신할 수 있습니다.)
|
|
53
57
|
|
|
54
|
-
|
|
58
|
+
**이 파일이 다음 작업으로 넘겨주는 기준입니다.** 저장소에 남기 때문에 이후 세션도 같은 결정을 다시 읽을 수 있습니다.
|
|
55
59
|
|
|
56
60
|
3. 이제 그 위에서 빌드하세요:
|
|
57
61
|
|
|
58
|
-
>
|
|
62
|
+
> DESIGN.md를 읽고 홈 화면을 디자인해줘. 기존 동작과 로고는 유지해.
|
|
59
63
|
|
|
60
|
-
에이전트가 `DESIGN.md
|
|
64
|
+
에이전트가 `DESIGN.md`에 기록된 결정을 읽고 작업합니다. 결과는 프로젝트 안에서 바로 확인할 수 있습니다.
|
|
61
65
|
|
|
62
66
|
Toss가 아니어도 됩니다 — `Stripe-style`, `Linear-clone B2B SaaS`, `Karrot-style marketplace` 전부 가능. 전체 카탈로그: [oh-my-design.kr/design-systems](https://oh-my-design.kr/design-systems).
|
|
63
67
|
|
|
@@ -65,33 +69,46 @@ Toss가 아니어도 됩니다 — `Stripe-style`, `Linear-clone B2B SaaS`, `Kar
|
|
|
65
69
|
|
|
66
70
|
| 에이전트 | 채널 | 설치되는 것 |
|
|
67
71
|
|---|---|---|
|
|
68
|
-
| **Claude Code** | `--agent claude-code` (기본) | 풀 번들 — `.claude/` 아래 스킬,
|
|
69
|
-
| **Codex** | `--agent codex` | `.agents/skills/`
|
|
70
|
-
| **OpenCode** | `--agent opencode` | `.opencode/skills
|
|
71
|
-
| **Cursor** | `--agent cursor` |
|
|
72
|
+
| **Claude Code** | `--agent claude-code` (기본) | 풀 번들 — `.claude/` 아래 스킬, 18 서브에이전트, hooks, data |
|
|
73
|
+
| **Codex** | `--agent codex` | `.agents/skills/` 스킬, `.codex/agents/` 내장 서브에이전트 역할, `.codex/data/` 로컬 카탈로그 |
|
|
74
|
+
| **OpenCode** | `--agent opencode` | 프로젝트: `.opencode/{skills,agents,data}/`의 스킬·네이티브 서브에이전트·카탈로그; 전역: `~/.config/opencode/{skills,agents,data}/`의 동일 번들 |
|
|
75
|
+
| **Cursor** | `--agent cursor` | 프로젝트 rule `.cursor/rules/omd-design.mdc` + 공용 `.claude/data` 카탈로그; OmD 스킬·서브에이전트·훅은 설치하지 않음 |
|
|
76
|
+
|
|
77
|
+
기본 설치는 감지된 모든 에이전트를 대상으로 합니다. 단일 채널을 비대화형으로 설치하려면 `npx oh-my-design-cli@latest install-skills --agent <name> --all`을 실행하세요.
|
|
78
|
+
|
|
79
|
+
### Cursor의 정확한 사용 경로
|
|
72
80
|
|
|
73
|
-
|
|
81
|
+
Cursor는 rules-only 채널이며 `omd:init`, `omd:feel`, OmD 서브에이전트를 실행하지 않습니다. 프로젝트 스펙은 다음 중 하나로 만드세요.
|
|
82
|
+
|
|
83
|
+
1. [Builder](https://oh-my-design.kr/builder)에서 레퍼런스를 선택·조정한 뒤 `DESIGN.md`를 내려받아 프로젝트 루트에 저장합니다.
|
|
84
|
+
2. Cursor에게 `Read .claude/data/references/toss/DESIGN.md and create a root DESIGN.md for this product using confirmed values only. Keep unknown facts absent.`라고 명시적으로 요청합니다.
|
|
85
|
+
|
|
86
|
+
그 다음 `@DESIGN.md를 읽고 동작은 유지한 채 홈 화면을 다시 디자인해줘`라고 요청하세요. 설치된 rule의 최소 계약은 `DESIGN.md` 우선, 대기 중인 `.omd/preferences.md` 교정 다음, 프레임워크 기본값 마지막입니다.
|
|
74
87
|
|
|
75
88
|
## 패키지 구성
|
|
76
89
|
|
|
77
|
-
**
|
|
90
|
+
**20 스킬 · 18 서브에이전트 · 440개 이상의 품질 등급형 레퍼런스 · 활성화 hooks**가 스킬 지원 채널의 전체 번들입니다. Cursor에는 의도적으로 rule과 카탈로그만 설치합니다.
|
|
78
91
|
|
|
79
|
-
- **스킬** — core flow (`omd:init` / `omd:apply` / `omd:harness` / `omd:sync` / `omd:remember` / `omd:learn` / `omd:taste` — "내 취향 보여줘" 한마디로 루프가 배운 것·대기 중·보류된 것을 한 뷰로), 라이브 캡처 + 에셋 (`omd:reference-capture` / `omd:asset-fetch` / `omd:experiment-gallery`),
|
|
80
|
-
- **서브에이전트** — `omd-master` +
|
|
81
|
-
- **레퍼런스** —
|
|
92
|
+
- **스킬** — core flow (`omd:init` / `omd:apply` / `omd:harness` / `omd:sync` / `omd:remember` / `omd:learn` / `omd:taste` — "내 취향 보여줘" 한마디로 루프가 배운 것·대기 중·보류된 것을 한 뷰로), 라이브 캡처 + 에셋 (`omd:reference-capture` / `omd:asset-fetch` / `omd:experiment-gallery`), 글쓰기와 리뷰 (`omd:orchestrator` / `omd:kr-writer` / `omd:locale-adapter` / `omd:humanize` / `omd:designer-review` / `omd:final-qa` / `omd:codex-image`), 인터페이스 품질 (`omd:feel` / `omd:slop-audit`), 그리고 터미널에서 claude.ai/design을 구동하는 단독 스킬 `claude-design`.
|
|
93
|
+
- **서브에이전트** — `omd-master` + 17 스페셜리스트 (UX 리서치, UI 생성, 에셋 큐레이션, 문장 다듬기, slop 감사, a11y 감사, 페르소나 테스트, 비평, …).
|
|
94
|
+
- **레퍼런스** — 기업 `DESIGN.md` 440개 이상에 근거와 품질 상태를 명시합니다. 모든 레퍼런스는 `oh-my-design.kr/<id>/design.md`에서 raw markdown으로도 제공되어 에이전트가 직접 가져올 수 있습니다.
|
|
82
95
|
- **Hooks** — UserPromptSubmit / SessionStart / PostToolUse 활성화 — 슬래시 명령 없이 자연어만으로 스킬이 발동합니다.
|
|
83
96
|
|
|
84
|
-
스킬·에이전트별 상세 레퍼런스: **[oh-my-design.kr/docs](https://oh-my-design.kr/docs)**.
|
|
97
|
+
스킬·에이전트별 상세 레퍼런스: **[oh-my-design.kr/docs/ko](https://oh-my-design.kr/docs/ko)**.
|
|
85
98
|
|
|
86
|
-
MCP
|
|
99
|
+
기존 catalog MCP transport는 종료했습니다. 스킬과 에이전트는 로컬 카탈로그 또는 raw `/<id>/design.md` 경로를 직접 사용하며, 과거 구현은 `packages/mcp/`에 archive로만 남겨 둡니다.
|
|
87
100
|
|
|
88
101
|
## 업그레이드
|
|
89
102
|
|
|
90
103
|
```bash
|
|
91
|
-
npx oh-my-design-cli@latest
|
|
104
|
+
npx oh-my-design-cli@latest
|
|
92
105
|
```
|
|
93
106
|
|
|
94
|
-
|
|
107
|
+
반복 실행해도 안전합니다. OmD 마커나 해시가 있는 관리 파일은 제자리에서 갱신하고, 사용자가 수정한 파일은 그대로 둡니다 (`skipped-drift`). 먼저 `doctor`가 출력한 범위 한정 복구 명령을 사용하세요. 관리형 Claude 훅이 오래됐으면 다른 미표시 파일을 덮어쓰지 않는 `--repair-hooks`가 자동으로 포함됩니다. `--force`는 의도적인 로컬 변경을 검토한 뒤에만 사용하세요. 다시 설치했다면 에이전트를 재시작하고 한 번 더 진단합니다.
|
|
108
|
+
|
|
109
|
+
```bash
|
|
110
|
+
npx oh-my-design-cli@latest doctor
|
|
111
|
+
```
|
|
95
112
|
|
|
96
113
|
```bash
|
|
97
114
|
npx oh-my-design-cli --version # 프로젝트에 깔린 버전
|
|
@@ -104,7 +121,7 @@ npm view oh-my-design-cli version # npm registry 최신
|
|
|
104
121
|
|
|
105
122
|
- **카탈로그** — [oh-my-design.kr/design-systems](https://oh-my-design.kr/design-systems) (모든 레퍼런스 + 에이전트용 raw `.md` twin)
|
|
106
123
|
- **컬렉션** — [oh-my-design.kr/collections](https://oh-my-design.kr/collections) (유스케이스별 큐레이션)
|
|
107
|
-
- **문서** — [oh-my-design.kr/docs](https://oh-my-design.kr/docs) (설치 옵션, 스킬, 에이전트, FAQ)
|
|
124
|
+
- **문서** — [oh-my-design.kr/docs/ko](https://oh-my-design.kr/docs/ko) (설치 옵션, 스킬, 에이전트, FAQ)
|
|
108
125
|
- **체인지로그** — [CHANGELOG.md](CHANGELOG.md) · 0.1.x에서 마이그레이션: [MIGRATION.md](MIGRATION.md)
|
|
109
126
|
|
|
110
127
|
## 라이선스
|
package/README.md
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
<p align="center">
|
|
2
|
-
<img src=".github/assets/logo-bg.png" width="480" alt="oh-my-design" />
|
|
2
|
+
<img src="https://raw.githubusercontent.com/kwakseongjae/oh-my-design/main/.github/assets/logo-bg.png" width="480" alt="oh-my-design" />
|
|
3
3
|
</p>
|
|
4
4
|
|
|
5
5
|
<h1 align="center">oh-my-design</h1>
|
|
6
6
|
|
|
7
7
|
<p align="center">
|
|
8
|
-
<strong>
|
|
8
|
+
<strong>Give your coding agent a project-owned DESIGN.md workflow.</strong> Guided installer + doctor, 20 reusable skills, 18 specialist roles, and 440+ quality-graded company references. Local workflows need no separate API key or MCP server.
|
|
9
9
|
</p>
|
|
10
10
|
|
|
11
11
|
<p align="center">
|
|
@@ -13,8 +13,8 @@
|
|
|
13
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>
|
|
14
14
|
<a href="LICENSE"><img src="https://img.shields.io/github/license/kwakseongjae/oh-my-design?style=flat-square" alt="License" /></a>
|
|
15
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>
|
|
16
|
-
<img src="https://img.shields.io/badge/references-
|
|
17
|
-
<img src="https://img.shields.io/badge/CLI%
|
|
16
|
+
<img src="https://img.shields.io/badge/references-440%2B-7c5cfc?style=flat-square" alt="440+ References" />
|
|
17
|
+
<img src="https://img.shields.io/badge/CLI-install%20%2B%20doctor-blue?style=flat-square" alt="Install and doctor CLI" />
|
|
18
18
|
</p>
|
|
19
19
|
|
|
20
20
|
<p align="center">
|
|
@@ -25,39 +25,43 @@
|
|
|
25
25
|
|
|
26
26
|
## What is oh-my-design?
|
|
27
27
|
|
|
28
|
-
**oh-my-design (OmD)**
|
|
28
|
+
**oh-my-design (OmD)** installs local design workflows into the coding tool you already use. Claude Code, Codex, and OpenCode receive reusable skills and specialist roles; Cursor receives a focused project rule that applies the same `DESIGN.md`. The file is a portable brand specification built from [Google Stitch](https://stitch.withgoogle.com/docs/design-md/overview/) tokens plus Voice, Narrative, Principles, Personas, States, and Motion. The package also includes 440+ quality-graded company references. **Core install and local workflows need no separate API key, daemon, or MCP server; inference stays inside your existing coding-agent session. The optional `claude-design` skill opens your logged-in claude.ai/design session in Chrome.**
|
|
29
29
|
|
|
30
30
|
## Install
|
|
31
31
|
|
|
32
32
|
```bash
|
|
33
|
-
npx oh-my-design-cli
|
|
33
|
+
npx oh-my-design-cli@latest
|
|
34
34
|
```
|
|
35
35
|
|
|
36
|
-
Then restart your agent
|
|
36
|
+
Then restart your agent so it discovers the newly installed channel files, and verify those files once. Codex users must also trust the project before project-local roles are loaded:
|
|
37
37
|
|
|
38
|
-
|
|
38
|
+
```bash
|
|
39
|
+
npx oh-my-design-cli@latest doctor
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
The CLI only bootstraps and diagnoses the bundle. Every design task after that is natural language to your agent.
|
|
39
43
|
|
|
40
|
-
The installer asks **where** to install: **Project** (
|
|
44
|
+
The installer asks **where** to install: **Project** (channel-local files in this repository, the default) or **Global** (user-level files available across projects). OpenCode uses `.opencode/` for project installs and `~/.config/opencode/` for global installs. Global installation leaves hooks/settings untouched. Use `npx oh-my-design-cli@latest install-skills --global` to select that scope non-interactively, then verify it with `npx oh-my-design-cli@latest doctor --global`.
|
|
41
45
|
|
|
42
|
-
## Your first 60 seconds
|
|
46
|
+
## Your first 60 seconds — Claude Code, Codex, or OpenCode
|
|
43
47
|
|
|
44
|
-
This is the
|
|
48
|
+
This is the shortest path from install to a visible result.
|
|
45
49
|
|
|
46
50
|
1. Install (above), then **restart your agent** (Cmd+Q, relaunch) so it loads the new skills.
|
|
47
51
|
|
|
48
52
|
2. In your project, type your first prompt — copy this exactly:
|
|
49
53
|
|
|
50
|
-
>
|
|
54
|
+
> Create a project-owned DESIGN.md for a family meal-tracking app. Use Toss as a reference, keep only verified reference facts, and ask before deciding product-specific facts.
|
|
51
55
|
|
|
52
|
-
Your agent runs **`omd:init`**: it recommends a reference from the
|
|
56
|
+
Your skill-enabled agent runs **`omd:init`**: it recommends a reference from the 440+ quality-graded company catalog, asks you to confirm, and writes **`DESIGN.md`** to your project root. (`omd:sync` can then update the managed agent-instruction shims.)
|
|
53
57
|
|
|
54
|
-
**That
|
|
58
|
+
**That file is the handoff.** It stays in your repository, so later sessions can read the same decisions again.
|
|
55
59
|
|
|
56
60
|
3. Now build against it:
|
|
57
61
|
|
|
58
|
-
>
|
|
62
|
+
> Read DESIGN.md and design the home screen. Preserve the current behavior and logo.
|
|
59
63
|
|
|
60
|
-
The agent reads `DESIGN.md
|
|
64
|
+
The agent reads `DESIGN.md`, works against the recorded decisions, and leaves a result you can inspect in the project.
|
|
61
65
|
|
|
62
66
|
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
67
|
|
|
@@ -65,33 +69,46 @@ Don't want Toss? Any brand works — `Stripe-style`, `Linear-clone B2B SaaS`, `K
|
|
|
65
69
|
|
|
66
70
|
| Agent | Channel | What gets installed |
|
|
67
71
|
|---|---|---|
|
|
68
|
-
| **Claude Code** | `--agent claude-code` (default) | Full bundle — skills,
|
|
69
|
-
| **Codex** | `--agent codex` |
|
|
70
|
-
| **OpenCode** | `--agent opencode` |
|
|
71
|
-
| **Cursor** | `--agent cursor` |
|
|
72
|
+
| **Claude Code** | `--agent claude-code` (default) | Full bundle — skills, 18 sub-agents, hooks, data under `.claude/` |
|
|
73
|
+
| **Codex** | `--agent codex` | Skills at `.agents/skills/`, embedded sub-agent roles under `.codex/agents/`, and the local catalog under `.codex/data/` |
|
|
74
|
+
| **OpenCode** | `--agent opencode` | Project: skills, native sub-agents, and catalog under `.opencode/{skills,agents,data}/`; global: the same bundle under `~/.config/opencode/{skills,agents,data}/` |
|
|
75
|
+
| **Cursor** | `--agent cursor` | Project rule `.cursor/rules/omd-design.mdc` + shared `.claude/data` catalog; no OmD skills, sub-agents, or hooks |
|
|
76
|
+
|
|
77
|
+
The default install targets every detected agent. For one non-interactive channel, run `npx oh-my-design-cli@latest install-skills --agent <name> --all`.
|
|
78
|
+
|
|
79
|
+
### Cursor's supported path
|
|
72
80
|
|
|
73
|
-
|
|
81
|
+
Cursor is a rules-only channel, not a host for `omd:init`, `omd:feel`, or the OmD sub-agents. Create the project spec in one of two ways:
|
|
82
|
+
|
|
83
|
+
1. Choose/customize a reference in the [Builder](https://oh-my-design.kr/builder), download `DESIGN.md`, and save it at the project root; or
|
|
84
|
+
2. ask Cursor: `Read .claude/data/references/toss/DESIGN.md and create a root DESIGN.md for this product using confirmed values only. Keep unknown facts absent.`
|
|
85
|
+
|
|
86
|
+
Then prompt Cursor: `Read @DESIGN.md and redesign the home screen without changing behavior.` The installed rule enforces the minimal contract: `DESIGN.md` first, pending `.omd/preferences.md` corrections second, framework defaults last.
|
|
74
87
|
|
|
75
88
|
## What's inside
|
|
76
89
|
|
|
77
|
-
**
|
|
90
|
+
**20 skills · 18 sub-agents · 440+ quality-graded references · activation hooks** make up the full skill-enabled bundle. Cursor intentionally receives only its rule and catalog.
|
|
78
91
|
|
|
79
|
-
- **Skills** — core flow (`omd:init` / `omd:apply` / `omd:harness` / `omd:sync` / `omd:remember` / `omd:learn` / `omd:taste` — say "what are my preferences" to see everything the loop has learned, pending, or snoozed), live capture + assets (`omd:reference-capture` / `omd:asset-fetch` / `omd:experiment-gallery`), the
|
|
80
|
-
- **Sub-agents** — `omd-master` +
|
|
81
|
-
- **References** —
|
|
92
|
+
- **Skills** — core flow (`omd:init` / `omd:apply` / `omd:harness` / `omd:sync` / `omd:remember` / `omd:learn` / `omd:taste` — say "what are my preferences" to see everything the loop has learned, pending, or snoozed), live capture + assets (`omd:reference-capture` / `omd:asset-fetch` / `omd:experiment-gallery`), the writing and review layer (`omd:orchestrator` / `omd:kr-writer` / `omd:locale-adapter` / `omd:humanize` / `omd:designer-review` / `omd:final-qa` / `omd:codex-image`), interface quality (`omd:feel` / `omd:slop-audit`), plus the standalone `claude-design` skill that drives claude.ai/design from your terminal.
|
|
93
|
+
- **Sub-agents** — `omd-master` + 17 specialists (UX research, UI generation, asset curation, copy humanization, slop auditing, a11y audit, persona testing, critique, …).
|
|
94
|
+
- **References** — 440+ company `DESIGN.md` files with explicit evidence and quality status. Every reference is also served as raw markdown at `oh-my-design.kr/<id>/design.md`, so agents can fetch it directly.
|
|
82
95
|
- **Hooks** — UserPromptSubmit / SessionStart / PostToolUse activation so the skills trigger on natural language, not just slash commands.
|
|
83
96
|
|
|
84
|
-
|
|
97
|
+
Outcome-first workflows, reproducible examples, and all five locales: **[oh-my-design.kr/docs/en](https://oh-my-design.kr/docs/en)** · [한국어](https://oh-my-design.kr/docs/ko) · [日本語](https://oh-my-design.kr/docs/ja) · [简体中文](https://oh-my-design.kr/docs/zh-cn) · [繁體中文](https://oh-my-design.kr/docs/zh-tw).
|
|
85
98
|
|
|
86
|
-
|
|
99
|
+
The old catalog MCP transport is retired. Skills and agents consume the local catalog or the raw `/<id>/design.md` route directly; the historical implementation remains under `packages/mcp/` as an archive.
|
|
87
100
|
|
|
88
101
|
## Upgrading
|
|
89
102
|
|
|
90
103
|
```bash
|
|
91
|
-
npx oh-my-design-cli@latest
|
|
104
|
+
npx oh-my-design-cli@latest
|
|
92
105
|
```
|
|
93
106
|
|
|
94
|
-
Idempotent. Managed files (those carrying
|
|
107
|
+
Idempotent. Managed files (those carrying OmD markers/hashes) are refreshed in place; files you edited are left untouched (`skipped-drift`). Run `doctor` and prefer the exact scoped repair command it prints. For stale managed Claude hooks that command includes `--repair-hooks`, which does not overwrite other unmarked files. Use `--force` only after reviewing intentional local drift. Restart your agent after re-running, then verify the refreshed bundle:
|
|
108
|
+
|
|
109
|
+
```bash
|
|
110
|
+
npx oh-my-design-cli@latest doctor
|
|
111
|
+
```
|
|
95
112
|
|
|
96
113
|
```bash
|
|
97
114
|
npx oh-my-design-cli --version # what your project currently uses
|
|
@@ -104,7 +121,8 @@ What changed each release — including anything that needs more than a re-insta
|
|
|
104
121
|
|
|
105
122
|
- **Catalog** — [oh-my-design.kr/design-systems](https://oh-my-design.kr/design-systems) (every reference, with raw `.md` twins for agents)
|
|
106
123
|
- **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)
|
|
124
|
+
- **Docs** — [oh-my-design.kr/docs/en](https://oh-my-design.kr/docs/en) (install options, skills, agents, FAQ)
|
|
125
|
+
- **Live demo playbook** — [oh-my-design.kr/docs/en/demo](https://oh-my-design.kr/docs/en/demo) (5-, 15-, and 30-minute formats with an evidence checklist)
|
|
108
126
|
- **Changelog** — [CHANGELOG.md](CHANGELOG.md) · migrating from 0.1.x: [MIGRATION.md](MIGRATION.md)
|
|
109
127
|
|
|
110
128
|
## License
|