@w3kits-com/plugin-opendesign 0.1.8
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/LICENSE +201 -0
- package/README.ar.md +829 -0
- package/README.de.md +745 -0
- package/README.es.md +812 -0
- package/README.fr.md +758 -0
- package/README.ja-JP.md +742 -0
- package/README.ko.md +749 -0
- package/README.md +1044 -0
- package/README.pt-BR.md +755 -0
- package/README.ru.md +754 -0
- package/README.tr.md +912 -0
- package/README.uk.md +754 -0
- package/README.zh-CN.md +747 -0
- package/README.zh-TW.md +814 -0
- package/dist/404/index.html +1 -0
- package/dist/404.html +1 -0
- package/dist/__next.$oc$slug.__PAGE__.txt +6 -0
- package/dist/__next.$oc$slug.txt +5 -0
- package/dist/__next._full.txt +19 -0
- package/dist/__next._head.txt +6 -0
- package/dist/__next._index.txt +7 -0
- package/dist/__next._tree.txt +2 -0
- package/dist/__w3kits/catalog/design-systems.json +1 -0
- package/dist/__w3kits/catalog/design-templates.json +1 -0
- package/dist/__w3kits/catalog/skills.json +1 -0
- package/dist/__w3kits/icon.svg +51 -0
- package/dist/_next/static/chunks/03~yq9q893hmn.js +1 -0
- package/dist/_next/static/chunks/04x4~r_ltq17a.js +1 -0
- package/dist/_next/static/chunks/05_595ph9d4yp.js +1 -0
- package/dist/_next/static/chunks/0jzvy---_kh9r.js +2485 -0
- package/dist/_next/static/chunks/0kf4c9h~6b0ok.js +1 -0
- package/dist/_next/static/chunks/0p.wvs8r3k6g7.js +1 -0
- package/dist/_next/static/chunks/0t2m~0~z4nk68.js +5 -0
- package/dist/_next/static/chunks/0vpcktbhmjn2u.js +1 -0
- package/dist/_next/static/chunks/0xfykg6_lmu3a.js +31 -0
- package/dist/_next/static/chunks/0~_k3q5_py.u5.css +2 -0
- package/dist/_next/static/chunks/13.bzhieaq182.js +1 -0
- package/dist/_next/static/chunks/turbopack-0abv9cd._a~w-js +1 -0
- package/dist/_next/static/ptaOAJFvinIcai1ShQRcW/_buildManifest.js +16 -0
- package/dist/_next/static/ptaOAJFvinIcai1ShQRcW/_clientMiddlewareManifest.js +1 -0
- package/dist/_next/static/ptaOAJFvinIcai1ShQRcW/_ssgManifest.js +1 -0
- package/dist/_not-found/__next._full.txt +18 -0
- package/dist/_not-found/__next._head.txt +6 -0
- package/dist/_not-found/__next._index.txt +7 -0
- package/dist/_not-found/__next._not-found.__PAGE__.txt +5 -0
- package/dist/_not-found/__next._not-found.txt +5 -0
- package/dist/_not-found/__next._tree.txt +2 -0
- package/dist/_not-found/index.html +1 -0
- package/dist/_not-found/index.txt +18 -0
- package/dist/agent-icons/claude.svg +1 -0
- package/dist/agent-icons/codex.svg +1 -0
- package/dist/agent-icons/copilot.svg +1 -0
- package/dist/agent-icons/cursor-agent.svg +1 -0
- package/dist/agent-icons/deepseek.svg +1 -0
- package/dist/agent-icons/devin.png +0 -0
- package/dist/agent-icons/gemini.svg +1 -0
- package/dist/agent-icons/hermes.svg +1 -0
- package/dist/agent-icons/kilo.svg +1 -0
- package/dist/agent-icons/kimi.svg +1 -0
- package/dist/agent-icons/kiro.svg +1 -0
- package/dist/agent-icons/mimo.svg +1 -0
- package/dist/agent-icons/opencode.svg +1 -0
- package/dist/agent-icons/pi.svg +1 -0
- package/dist/agent-icons/qoder.svg +1 -0
- package/dist/agent-icons/qwen.svg +1 -0
- package/dist/agent-icons/vibe.svg +1 -0
- package/dist/app-icon.svg +51 -0
- package/dist/avatar.png +0 -0
- package/dist/browser-daemon.js +9 -0
- package/dist/index.html +1 -0
- package/dist/index.txt +19 -0
- package/dist/logo.svg +15 -0
- package/dist/od-notifications-sw.js +39 -0
- package/dist/w3kits-daemon-sw.js +77 -0
- package/package.json +60 -0
package/README.md
ADDED
|
@@ -0,0 +1,1044 @@
|
|
|
1
|
+
# Open Design
|
|
2
|
+
|
|
3
|
+
> **The open-source alternative to [Claude Design][cd].** Local-first, web-deployable, BYOK at every layer — **16 coding-agent CLIs** auto-detected on your `PATH` (Claude Code, Codex, Devin for Terminal, Cursor Agent, Gemini CLI, OpenCode, Qwen, Qoder CLI, GitHub Copilot CLI, Hermes, Kimi, Pi, Kiro, Kilo, Mistral Vibe, DeepSeek TUI) become the design engine, driven by **31 composable Skills** and **72 brand-grade Design Systems**. No CLI? An OpenAI-compatible BYOK proxy is the same loop minus the spawn.
|
|
4
|
+
|
|
5
|
+
<p align="center">
|
|
6
|
+
<img src="docs/assets/banner.png" alt="Open Design — editorial cover: design with the agent on your laptop" width="100%" />
|
|
7
|
+
</p>
|
|
8
|
+
|
|
9
|
+
<p align="center">
|
|
10
|
+
<a href="https://github.com/nexu-io/open-design/stargazers"><img alt="Stars" src="https://img.shields.io/github/stars/nexu-io/open-design?style=for-the-badge&labelColor=0d1117&color=ffd700&logo=github&logoColor=white" /></a>
|
|
11
|
+
<a href="https://github.com/nexu-io/open-design/network/members"><img alt="Forks" src="https://img.shields.io/github/forks/nexu-io/open-design?style=for-the-badge&labelColor=0d1117&color=2ecc71&logo=github&logoColor=white" /></a>
|
|
12
|
+
<a href="https://github.com/nexu-io/open-design/issues"><img alt="Issues" src="https://img.shields.io/github/issues/nexu-io/open-design?style=for-the-badge&labelColor=0d1117&color=ff6b6b&logo=github&logoColor=white" /></a>
|
|
13
|
+
<a href="https://github.com/nexu-io/open-design/pulls"><img alt="Pull Requests" src="https://img.shields.io/github/issues-pr/nexu-io/open-design?style=for-the-badge&labelColor=0d1117&color=9b59b6&logo=github&logoColor=white" /></a>
|
|
14
|
+
<a href="https://github.com/nexu-io/open-design/graphs/contributors"><img alt="Contributors" src="https://img.shields.io/github/contributors/nexu-io/open-design?style=for-the-badge&labelColor=0d1117&color=3498db&logo=github&logoColor=white" /></a>
|
|
15
|
+
<a href="https://github.com/nexu-io/open-design/commits/main"><img alt="Commit activity" src="https://img.shields.io/github/commit-activity/m/nexu-io/open-design?style=for-the-badge&labelColor=0d1117&color=e67e22&logo=git&logoColor=white" /></a>
|
|
16
|
+
<a href="https://github.com/nexu-io/open-design/commits/main"><img alt="Last commit" src="https://img.shields.io/github/last-commit/nexu-io/open-design?style=for-the-badge&labelColor=0d1117&color=8e44ad&logo=git&logoColor=white" /></a>
|
|
17
|
+
</p>
|
|
18
|
+
|
|
19
|
+
<p align="center">
|
|
20
|
+
<a href="https://open-design.ai/"><img alt="Download" src="https://img.shields.io/badge/download-open--design.ai-ff6b35?style=flat-square" /></a>
|
|
21
|
+
<a href="https://github.com/nexu-io/open-design/releases"><img alt="Latest release" src="https://img.shields.io/github/v/release/nexu-io/open-design?style=flat-square&color=blueviolet&label=release&include_prereleases&display_name=tag" /></a>
|
|
22
|
+
<a href="LICENSE"><img alt="License" src="https://img.shields.io/badge/license-Apache%202.0-blue.svg?style=flat-square" /></a>
|
|
23
|
+
<a href="#supported-coding-agents"><img alt="Agents" src="https://img.shields.io/badge/agents-16%20CLIs%20%2B%20BYOK%20proxy-black?style=flat-square" /></a>
|
|
24
|
+
<a href="#design-systems"><img alt="Design systems" src="https://img.shields.io/badge/design%20systems-72-orange?style=flat-square" /></a>
|
|
25
|
+
<a href="#skills"><img alt="Skills" src="https://img.shields.io/badge/skills-31-teal?style=flat-square" /></a>
|
|
26
|
+
<a href="https://discord.gg/qhbcCH8Am4"><img alt="Discord" src="https://img.shields.io/badge/discord-join-5865F2?style=flat-square&logo=discord&logoColor=white" /></a>
|
|
27
|
+
<a href="https://x.com/nexudotio"><img alt="Follow @nexudotio on X" src="https://img.shields.io/badge/follow-%40nexudotio-1DA1F2?style=flat-square&logo=x&logoColor=white" /></a>
|
|
28
|
+
<a href="QUICKSTART.md"><img alt="Quickstart" src="https://img.shields.io/badge/quickstart-3%20commands-green?style=flat-square" /></a>
|
|
29
|
+
</p>
|
|
30
|
+
|
|
31
|
+
<p align="center"><b>English</b> · <a href="README.es.md">Español</a> · <a href="README.pt-BR.md">Português (Brasil)</a> · <a href="README.de.md">Deutsch</a> · <a href="README.fr.md">Français</a> · <a href="README.zh-CN.md">简体中文</a> · <a href="README.zh-TW.md">繁體中文</a> · <a href="README.ko.md">한국어</a> · <a href="README.ja-JP.md">日本語</a> · <a href="README.ar.md">العربية</a> · <a href="README.ru.md">Русский</a> · <a href="README.uk.md">Українська</a> · <a href="README.tr.md">Türkçe</a></p>
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
## Why this exists
|
|
36
|
+
|
|
37
|
+
Anthropic's [Claude Design][cd] (released 2026-04-17, Opus 4.7) showed what happens when an LLM stops writing prose and starts shipping design artifacts. It went viral — and stayed closed-source, paid-only, cloud-only, locked to Anthropic's model and Anthropic's skills. There is no checkout, no self-host, no Vercel deploy, no swap-in-your-own-agent.
|
|
38
|
+
|
|
39
|
+
**Open Design (OD) is the open-source alternative.** Same loop, same artifact-first mental model, none of the lock-in. We don't ship an agent — the strongest coding agents already live on your laptop. We wire them into a skill-driven design workflow that runs locally with `pnpm tools-dev`, can deploy the web layer to Vercel, and stays BYOK at every layer.
|
|
40
|
+
|
|
41
|
+
Type `make me a magazine-style pitch deck for our seed round`. The interactive question form pops up before the model improvises a single pixel. The agent picks one of five curated visual directions. A live `TodoWrite` plan streams into the UI. The daemon builds a real on-disk project folder with a seed template, layout library, and self-check checklist. The agent reads them — pre-flight enforced — runs a five-dimensional critique against its own output, and emits a single `<artifact>` that renders in a sandboxed iframe seconds later.
|
|
42
|
+
|
|
43
|
+
That's not "AI tries to design something". That's an AI that has been trained, by the prompt stack, to behave like a senior designer with a working filesystem, a deterministic palette library, and a checklist culture — exactly the bar Claude Design set, but open and yours.
|
|
44
|
+
|
|
45
|
+
OD stands on four open-source shoulders:
|
|
46
|
+
|
|
47
|
+
- [**`alchaincyf/huashu-design`**](https://github.com/alchaincyf/huashu-design) — the design-philosophy compass. Junior-Designer workflow, the 5-step brand-asset protocol, the anti-AI-slop checklist, the 5-dimensional self-critique, and the "5 schools × 20 design philosophies" idea behind our direction picker — all distilled into [`apps/daemon/src/prompts/discovery.ts`](apps/daemon/src/prompts/discovery.ts).
|
|
48
|
+
- [**`op7418/guizang-ppt-skill`**](https://github.com/op7418/guizang-ppt-skill) — the deck mode. Bundled verbatim under [`skills/guizang-ppt/`](skills/guizang-ppt/) with original LICENSE preserved; magazine-style layouts, WebGL hero, P0/P1/P2 checklists.
|
|
49
|
+
- [**`OpenCoworkAI/open-codesign`**](https://github.com/OpenCoworkAI/open-codesign) — the UX north star and our closest peer. The first open-source Claude-Design alternative. We borrow its streaming-artifact loop, its sandboxed-iframe preview pattern (vendored React 18 + Babel), its live agent panel (todos + tool calls + interruptible generation), and its five-format export list (HTML / PDF / PPTX / ZIP / Markdown). We deliberately diverge on form factor — they are a desktop Electron app bundling [`pi-ai`][piai]; we are a web app + local daemon that delegates to your existing CLI.
|
|
50
|
+
- [**`multica-ai/multica`**](https://github.com/multica-ai/multica) — the daemon-and-runtime architecture. PATH-scan agent detection, the local daemon as the only privileged process, the agent-as-teammate worldview.
|
|
51
|
+
|
|
52
|
+
## At a glance
|
|
53
|
+
|
|
54
|
+
| | What you get |
|
|
55
|
+
|---|---|
|
|
56
|
+
| **Coding-agent CLIs (16)** | Claude Code · Codex CLI · Devin for Terminal · Cursor Agent · Gemini CLI · OpenCode · Qwen Code · Qoder CLI · GitHub Copilot CLI · Hermes (ACP) · Kimi CLI (ACP) · Pi (RPC) · Kiro CLI (ACP) · Kilo (ACP) · Mistral Vibe CLI (ACP) · DeepSeek TUI — auto-detected on `PATH`, swap with one click |
|
|
57
|
+
| **BYOK fallback** | Protocol-specific API proxy at `/api/proxy/{anthropic,openai,azure,google}/stream` — paste `baseUrl` + `apiKey` + `model`, choose Anthropic / OpenAI / Azure OpenAI / Google Gemini, and the daemon normalizes SSE back to the same chat stream. Internal-IP/SSRF blocked at the daemon edge. |
|
|
58
|
+
| **Design systems built-in** | **129** — 2 hand-authored starters + 70 product systems (Linear, Stripe, Vercel, Airbnb, Tesla, Notion, Anthropic, Apple, Cursor, Supabase, Figma, Xiaohongshu, …) from [`awesome-design-md`][acd2], plus 57 design skills from [`awesome-design-skills`][ads] added directly under `design-systems/` |
|
|
59
|
+
| **Skills built-in** | **31** — 27 in `prototype` mode (web-prototype, saas-landing, dashboard, mobile-app, gamified-app, social-carousel, magazine-poster, dating-web, sprite-animation, motion-frames, critique, tweaks, wireframe-sketch, pm-spec, eng-runbook, finance-report, hr-onboarding, invoice, kanban-board, team-okrs, …) + 4 in `deck` mode (`guizang-ppt` · `simple-deck` · `replit-deck` · `weekly-update`). Grouped in the picker by `scenario`: design / marketing / operation / engineering / product / finance / hr / sale / personal. |
|
|
60
|
+
| **Media generation** | Image · video · audio surfaces ship alongside the design loop. **gpt-image-2** (Azure / OpenAI) for posters, avatars, infographics, illustrated maps · **Seedance 2.0** (ByteDance) for cinematic 15s text-to-video and image-to-video · **HyperFrames** ([heygen-com/hyperframes](https://github.com/heygen-com/hyperframes)) for HTML→MP4 motion graphics (product reveals, kinetic typography, data charts, social overlays, logo outros). **93** ready-to-replicate prompts gallery — 43 gpt-image-2 + 39 Seedance + 11 HyperFrames — under [`prompt-templates/`](prompt-templates/), with preview thumbnails and source attribution. Same chat surface as code; outputs a real `.mp4` / `.png` chip into the project workspace. |
|
|
61
|
+
| **Visual directions** | 5 curated schools (Editorial Monocle · Modern Minimal · Warm Soft · Tech Utility · Brutalist Experimental) — each ships a deterministic OKLch palette + font stack ([`apps/daemon/src/prompts/directions.ts`](apps/daemon/src/prompts/directions.ts)) |
|
|
62
|
+
| **Device frames** | iPhone 15 Pro · Pixel · iPad Pro · MacBook · Browser Chrome — pixel-accurate, shared across skills under [`assets/frames/`](assets/frames/) |
|
|
63
|
+
| **Agent runtime** | Local daemon spawns the CLI in your project folder — agent gets real `Read`, `Write`, `Bash`, `WebFetch` against a real on-disk environment, with Windows `ENAMETOOLONG` fallbacks (stdin / prompt-file) on every adapter |
|
|
64
|
+
| **Imports** | Drop a [Claude Design][cd] export ZIP onto the welcome dialog — `POST /api/import/claude-design` parses it into a real project so your agent can keep editing where Anthropic left off |
|
|
65
|
+
| **Persistence** | SQLite at `.od/app.sqlite`: projects · conversations · messages · tabs · saved templates. Reopen tomorrow, todo card and open files are exactly where you left them. |
|
|
66
|
+
| **Lifecycle** | One entry point: `pnpm tools-dev` (start / stop / run / status / logs / inspect / check) — boots daemon + web (+ desktop) under typed sidecar stamps |
|
|
67
|
+
| **Desktop** | Optional Electron shell with sandboxed renderer + sidecar IPC (STATUS / EVAL / SCREENSHOT / CONSOLE / CLICK / SHUTDOWN) — drives `tools-dev inspect desktop screenshot` for E2E |
|
|
68
|
+
| **Deployable to** | Local (`pnpm tools-dev`) · Vercel web layer · packaged Electron desktop app for macOS (Apple Silicon) and Windows (x64) — download from [open-design.ai](https://open-design.ai/) or the [latest release](https://github.com/nexu-io/open-design/releases) |
|
|
69
|
+
| **License** | Apache-2.0 |
|
|
70
|
+
|
|
71
|
+
Linux AppImage packaging is available through the optional release lane and is covered by the Linux packaged smoke workflow, but public stable downloads remain gated until the release maintainers enable the Linux stable lane.
|
|
72
|
+
|
|
73
|
+
[acd2]: https://github.com/VoltAgent/awesome-design-md
|
|
74
|
+
[ads]: https://github.com/bergside/awesome-design-skills
|
|
75
|
+
|
|
76
|
+
## Demo
|
|
77
|
+
|
|
78
|
+
<table>
|
|
79
|
+
<tr>
|
|
80
|
+
<td width="50%">
|
|
81
|
+
<img src="docs/screenshots/01-entry-view.png" alt="01 · Entry view" /><br/>
|
|
82
|
+
<sub><b>Entry view</b> — pick a skill, pick a design system, type the brief. The same surface for prototypes, decks, mobile apps, dashboards, and editorial pages.</sub>
|
|
83
|
+
</td>
|
|
84
|
+
<td width="50%">
|
|
85
|
+
<img src="docs/screenshots/02-question-form.png" alt="02 · Turn-1 discovery form" /><br/>
|
|
86
|
+
<sub><b>Turn-1 discovery form</b> — before the model writes a pixel, OD locks the brief: surface, audience, tone, brand context, scale. 30 seconds of radios beats 30 minutes of redirects.</sub>
|
|
87
|
+
</td>
|
|
88
|
+
</tr>
|
|
89
|
+
<tr>
|
|
90
|
+
<td width="50%">
|
|
91
|
+
<img src="docs/screenshots/03-direction-picker.png" alt="03 · Direction picker" /><br/>
|
|
92
|
+
<sub><b>Direction picker</b> — when the user has no brand, the agent emits a second form with 5 curated directions (Monocle / Modern Minimal / Tech Utility / Brutalist / Soft Warm). One radio click → a deterministic palette + font stack, no model freestyle.</sub>
|
|
93
|
+
</td>
|
|
94
|
+
<td width="50%">
|
|
95
|
+
<img src="docs/screenshots/04-todo-progress.png" alt="04 · Live todo progress" /><br/>
|
|
96
|
+
<sub><b>Live todo progress</b> — the agent's plan streams as a live card. <code>in_progress</code> → <code>completed</code> updates land in real time. The user can redirect cheaply, mid-flight.</sub>
|
|
97
|
+
</td>
|
|
98
|
+
</tr>
|
|
99
|
+
<tr>
|
|
100
|
+
<td width="50%">
|
|
101
|
+
<img src="docs/screenshots/05-preview-iframe.png" alt="05 · Sandboxed preview" /><br/>
|
|
102
|
+
<sub><b>Sandboxed preview</b> — every <code><artifact></code> renders in a clean srcdoc iframe. Editable in place via the file workspace; downloadable as HTML, PDF, ZIP.</sub>
|
|
103
|
+
</td>
|
|
104
|
+
<td width="50%">
|
|
105
|
+
<img src="docs/screenshots/06-design-systems-library.png" alt="06 · 72-system library" /><br/>
|
|
106
|
+
<sub><b>72-system library</b> — every product system shows its 4-color signature. Click for the full <code>DESIGN.md</code>, swatch grid, and live showcase.</sub>
|
|
107
|
+
</td>
|
|
108
|
+
</tr>
|
|
109
|
+
<tr>
|
|
110
|
+
<td width="50%">
|
|
111
|
+
<img src="docs/screenshots/07-magazine-deck.png" alt="07 · Magazine deck" /><br/>
|
|
112
|
+
<sub><b>Deck mode (guizang-ppt)</b> — the bundled <a href="https://github.com/op7418/guizang-ppt-skill"><code>guizang-ppt-skill</code></a> drops in unchanged. Magazine layouts, WebGL hero backgrounds, single-file HTML output, PDF export.</sub>
|
|
113
|
+
</td>
|
|
114
|
+
<td width="50%">
|
|
115
|
+
<img src="docs/screenshots/08-mobile-app.png" alt="08 · Mobile prototype" /><br/>
|
|
116
|
+
<sub><b>Mobile prototype</b> — pixel-accurate iPhone 15 Pro chrome (Dynamic Island, status bar SVGs, home indicator). Multi-screen prototypes use the shared <code>/frames/</code> assets so the agent never re-draws a phone.</sub>
|
|
117
|
+
</td>
|
|
118
|
+
</tr>
|
|
119
|
+
</table>
|
|
120
|
+
|
|
121
|
+
## Skills
|
|
122
|
+
|
|
123
|
+
**31 skills ship in the box.** Each is a folder under [`skills/`](skills/) following the Claude Code [`SKILL.md`][skill] convention with an extended `od:` frontmatter that the daemon parses verbatim — `mode`, `platform`, `scenario`, `preview.type`, `design_system.requires`, `default_for`, `featured`, `fidelity`, `speaker_notes`, `animations`, `example_prompt` ([`apps/daemon/src/skills.ts`](apps/daemon/src/skills.ts)).
|
|
124
|
+
|
|
125
|
+
Two top-level **modes** carry the catalog: **`prototype`** (27 skills — anything that renders as a single-page artifact, from a magazine landing to a phone screen to a PM spec doc) and **`deck`** (4 skills — horizontal-swipe presentations with deck-framework chrome). The **`scenario`** field is what the picker groups them by: `design` · `marketing` · `operation` · `engineering` · `product` · `finance` · `hr` · `sale` · `personal`.
|
|
126
|
+
|
|
127
|
+
### Showcase examples
|
|
128
|
+
|
|
129
|
+
The visually distinctive skills you'll most likely run first. Each ships a real `example.html` you can open straight from the repo to see exactly what the agent will produce — no auth, no setup.
|
|
130
|
+
|
|
131
|
+
<table>
|
|
132
|
+
<tr>
|
|
133
|
+
<td width="50%" valign="top">
|
|
134
|
+
<a href="skills/dating-web/"><img src="docs/screenshots/skills/dating-web.png" alt="dating-web" /></a><br/>
|
|
135
|
+
<sub><b><a href="skills/dating-web/"><code>dating-web</code></a></b> · <i>prototype</i><br/>Consumer dating / matchmaking dashboard — left rail nav, ticker bar, KPIs, 30-day mutual-matches chart, editorial typography.</sub>
|
|
136
|
+
</td>
|
|
137
|
+
<td width="50%" valign="top">
|
|
138
|
+
<a href="skills/digital-eguide/"><img src="docs/screenshots/skills/digital-eguide.png" alt="digital-eguide" /></a><br/>
|
|
139
|
+
<sub><b><a href="skills/digital-eguide/"><code>digital-eguide</code></a></b> · <i>template</i><br/>Two-spread digital e-guide — cover (title, author, TOC teaser) + lesson spread with pull-quote and step list. Creator / lifestyle tone.</sub>
|
|
140
|
+
</td>
|
|
141
|
+
</tr>
|
|
142
|
+
<tr>
|
|
143
|
+
<td width="50%" valign="top">
|
|
144
|
+
<a href="skills/email-marketing/"><img src="docs/screenshots/skills/email-marketing.png" alt="email-marketing" /></a><br/>
|
|
145
|
+
<sub><b><a href="skills/email-marketing/"><code>email-marketing</code></a></b> · <i>prototype</i><br/>Brand product-launch HTML email — masthead, hero image, headline lockup, CTA, specs grid. Centered single-column, table-fallback safe.</sub>
|
|
146
|
+
</td>
|
|
147
|
+
<td width="50%" valign="top">
|
|
148
|
+
<a href="skills/gamified-app/"><img src="docs/screenshots/skills/gamified-app.png" alt="gamified-app" /></a><br/>
|
|
149
|
+
<sub><b><a href="skills/gamified-app/"><code>gamified-app</code></a></b> · <i>prototype</i><br/>Three-frame gamified mobile-app prototype on a dark showcase stage — cover, today's quests with XP ribbons + level bar, quest detail.</sub>
|
|
150
|
+
</td>
|
|
151
|
+
</tr>
|
|
152
|
+
<tr>
|
|
153
|
+
<td width="50%" valign="top">
|
|
154
|
+
<a href="skills/mobile-onboarding/"><img src="docs/screenshots/skills/mobile-onboarding.png" alt="mobile-onboarding" /></a><br/>
|
|
155
|
+
<sub><b><a href="skills/mobile-onboarding/"><code>mobile-onboarding</code></a></b> · <i>prototype</i><br/>Three-frame mobile onboarding flow — splash, value-prop, sign-in. Status bar, swipe dots, primary CTA.</sub>
|
|
156
|
+
</td>
|
|
157
|
+
<td width="50%" valign="top">
|
|
158
|
+
<a href="skills/motion-frames/"><img src="docs/screenshots/skills/motion-frames.png" alt="motion-frames" /></a><br/>
|
|
159
|
+
<sub><b><a href="skills/motion-frames/"><code>motion-frames</code></a></b> · <i>prototype</i><br/>Single-frame motion-design hero with looping CSS animations — rotating type ring, animated globe, ticking timer. Hand-off ready for HyperFrames.</sub>
|
|
160
|
+
</td>
|
|
161
|
+
</tr>
|
|
162
|
+
<tr>
|
|
163
|
+
<td width="50%" valign="top">
|
|
164
|
+
<a href="skills/social-carousel/"><img src="docs/screenshots/skills/social-carousel.png" alt="social-carousel" /></a><br/>
|
|
165
|
+
<sub><b><a href="skills/social-carousel/"><code>social-carousel</code></a></b> · <i>prototype</i><br/>Three-card 1080×1080 social-media carousel — cinematic panels with display headlines that connect across the series, brand mark, loop affordance.</sub>
|
|
166
|
+
</td>
|
|
167
|
+
<td width="50%" valign="top">
|
|
168
|
+
<a href="skills/sprite-animation/"><img src="docs/screenshots/skills/sprite-animation.png" alt="sprite-animation" /></a><br/>
|
|
169
|
+
<sub><b><a href="skills/sprite-animation/"><code>sprite-animation</code></a></b> · <i>prototype</i><br/>Pixel / 8-bit animated explainer slide — full-bleed cream stage, animated pixel mascot, kinetic Japanese display type, looping CSS keyframes.</sub>
|
|
170
|
+
</td>
|
|
171
|
+
</tr>
|
|
172
|
+
</table>
|
|
173
|
+
|
|
174
|
+
### Design & marketing surfaces (prototype mode)
|
|
175
|
+
|
|
176
|
+
| Skill | Platform | Scenario | What it produces |
|
|
177
|
+
|---|---|---|---|
|
|
178
|
+
| [`web-prototype`](skills/web-prototype/) | desktop | design | Single-page HTML — landings, marketing, hero pages (default for prototype) |
|
|
179
|
+
| [`saas-landing`](skills/saas-landing/) | desktop | marketing | Hero / features / pricing / CTA marketing layout |
|
|
180
|
+
| [`dashboard`](skills/dashboard/) | desktop | operation | Admin / analytics with sidebar + dense data layout |
|
|
181
|
+
| [`pricing-page`](skills/pricing-page/) | desktop | sale | Standalone pricing + comparison tables |
|
|
182
|
+
| [`docs-page`](skills/docs-page/) | desktop | engineering | 3-column documentation layout |
|
|
183
|
+
| [`blog-post`](skills/blog-post/) | desktop | marketing | Editorial long-form |
|
|
184
|
+
| [`mobile-app`](skills/mobile-app/) | mobile | design | iPhone 15 Pro / Pixel framed app screen(s) |
|
|
185
|
+
| [`mobile-onboarding`](skills/mobile-onboarding/) | mobile | design | Multi-screen mobile onboarding flow (splash · value-prop · sign-in) |
|
|
186
|
+
| [`gamified-app`](skills/gamified-app/) | mobile | personal | Three-frame gamified mobile-app prototype |
|
|
187
|
+
| [`email-marketing`](skills/email-marketing/) | desktop | marketing | Brand product-launch HTML email (table-fallback safe) |
|
|
188
|
+
| [`social-carousel`](skills/social-carousel/) | desktop | marketing | 3-card 1080×1080 social carousel |
|
|
189
|
+
| [`magazine-poster`](skills/magazine-poster/) | desktop | marketing | Single-page magazine-style poster |
|
|
190
|
+
| [`motion-frames`](skills/motion-frames/) | desktop | marketing | Motion-design hero with looping CSS animations |
|
|
191
|
+
| [`sprite-animation`](skills/sprite-animation/) | desktop | marketing | Pixel / 8-bit animated explainer slide |
|
|
192
|
+
| [`dating-web`](skills/dating-web/) | desktop | personal | Consumer dating dashboard mockup |
|
|
193
|
+
| [`digital-eguide`](skills/digital-eguide/) | desktop | marketing | Two-spread digital e-guide (cover + lesson) |
|
|
194
|
+
| [`wireframe-sketch`](skills/wireframe-sketch/) | desktop | design | Hand-drawn ideation sketch — for the "show something visible early" pass |
|
|
195
|
+
| [`critique`](skills/critique/) | desktop | design | Five-dimensional self-critique scoresheet (Philosophy · Hierarchy · Detail · Function · Innovation) |
|
|
196
|
+
| [`tweaks`](skills/tweaks/) | desktop | design | AI-emitted tweaks panel — the model surfaces the parameters worth nudging |
|
|
197
|
+
|
|
198
|
+
### Deck surfaces (deck mode)
|
|
199
|
+
|
|
200
|
+
| Skill | Default for | What it produces |
|
|
201
|
+
|---|---|---|
|
|
202
|
+
| [`guizang-ppt`](skills/guizang-ppt/) | **default** for deck | Magazine-style web PPT — bundled verbatim from [op7418/guizang-ppt-skill][guizang], original LICENSE preserved |
|
|
203
|
+
| [`simple-deck`](skills/simple-deck/) | — | Minimal horizontal-swipe deck |
|
|
204
|
+
| [`replit-deck`](skills/replit-deck/) | — | Product-walkthrough deck (Replit-style) |
|
|
205
|
+
| [`weekly-update`](skills/weekly-update/) | — | Team weekly cadence as a swipe deck (progress · blockers · next) |
|
|
206
|
+
|
|
207
|
+
### Office & operations surfaces (prototype mode, document-flavored scenarios)
|
|
208
|
+
|
|
209
|
+
| Skill | Scenario | What it produces |
|
|
210
|
+
|---|---|---|
|
|
211
|
+
| [`pm-spec`](skills/pm-spec/) | product | PM specification doc with TOC + decision log |
|
|
212
|
+
| [`team-okrs`](skills/team-okrs/) | product | OKR scoresheet |
|
|
213
|
+
| [`meeting-notes`](skills/meeting-notes/) | operation | Meeting decision log |
|
|
214
|
+
| [`kanban-board`](skills/kanban-board/) | operation | Board snapshot |
|
|
215
|
+
| [`eng-runbook`](skills/eng-runbook/) | engineering | Incident runbook |
|
|
216
|
+
| [`finance-report`](skills/finance-report/) | finance | Exec finance summary |
|
|
217
|
+
| [`invoice`](skills/invoice/) | finance | Single-page invoice |
|
|
218
|
+
| [`hr-onboarding`](skills/hr-onboarding/) | hr | Role onboarding plan |
|
|
219
|
+
|
|
220
|
+
Adding a skill takes one folder. Read [`docs/skills-protocol.md`](docs/skills-protocol.md) for the extended frontmatter, fork an existing skill, restart the daemon, it appears in the picker. The catalog endpoint is `GET /api/skills`; per-skill seed assembly (template + side-file references) lives at `GET /api/skills/:id/example`.
|
|
221
|
+
|
|
222
|
+
## Six load-bearing ideas
|
|
223
|
+
|
|
224
|
+
### 1 · We don't ship an agent. Yours is good enough.
|
|
225
|
+
|
|
226
|
+
The daemon scans your `PATH` for [`claude`](https://docs.anthropic.com/en/docs/claude-code), [`codex`](https://github.com/openai/codex), `devin`, [`cursor-agent`](https://www.cursor.com/cli), [`gemini`](https://github.com/google-gemini/gemini-cli), [`opencode`](https://opencode.ai/), [`qwen`](https://github.com/QwenLM/qwen-code), `qodercli`, [`copilot`](https://github.com/features/copilot/cli), `hermes`, `kimi`, [`pi`](https://github.com/badlogic/pi-mono/tree/main/packages/coding-agent), [`kiro-cli`](https://kiro.dev), `kilo`, [`vibe-acp`](https://github.com/mistralai/mistral-vibe), and `deepseek` on startup. Whichever ones it finds become candidate design engines — driven over stdio with one adapter per CLI, swappable from the model picker. Inspired by [`multica`](https://github.com/multica-ai/multica) and [`cc-switch`](https://github.com/farion1231/cc-switch). No CLI installed? The API mode is the same pipeline minus the spawn — choose Anthropic, OpenAI-compatible, Azure OpenAI, or Google Gemini and the daemon forwards normalized SSE chunks back. Loopback is allowed for local LLM providers such as Ollama and LM Studio; non-loopback private, link-local, CGNAT, multicast, reserved, and redirect targets are rejected at the daemon edge.
|
|
227
|
+
|
|
228
|
+
### 2 · Skills are files, not plugins.
|
|
229
|
+
|
|
230
|
+
Following Claude Code's [`SKILL.md` convention](https://docs.anthropic.com/en/docs/claude-code/skills), each skill is `SKILL.md` + `assets/` + `references/`. Drop a folder into [`skills/`](skills/), restart the daemon, it appears in the picker. The bundled `magazine-web-ppt` is [`op7418/guizang-ppt-skill`](https://github.com/op7418/guizang-ppt-skill) committed verbatim — original license preserved, attribution preserved.
|
|
231
|
+
|
|
232
|
+
### 3 · Design Systems are portable Markdown, not theme JSON.
|
|
233
|
+
|
|
234
|
+
The 9-section `DESIGN.md` schema from [`VoltAgent/awesome-design-md`][acd2] — color, typography, spacing, layout, components, motion, voice, brand, anti-patterns. Every artifact reads from the active system. Switch system → next render uses the new tokens. The dropdown ships with **Linear, Stripe, Vercel, Airbnb, Tesla, Notion, Apple, Anthropic, Cursor, Supabase, Figma, Resend, Raycast, Lovable, Cohere, Mistral, ElevenLabs, X.AI, Spotify, Webflow, Sanity, PostHog, Sentry, MongoDB, ClickHouse, Cal, Replicate, Clay, Composio, Xiaohongshu…** — plus 57 design skills sourced from [`awesome-design-skills`][ads].
|
|
235
|
+
|
|
236
|
+
### 4 · The interactive question form prevents 80% of redirects.
|
|
237
|
+
|
|
238
|
+
OD's prompt stack hard-codes a `RULE 1`: every fresh design brief begins with a `<question-form id="discovery">` instead of code. Surface · audience · tone · brand context · scale · constraints. A long brief still leaves design decisions open — visual tone, color stance, scale — exactly the things the form locks down in 30 seconds. The cost of a wrong direction is one chat round, not one finished deck.
|
|
239
|
+
|
|
240
|
+
This is the **Junior-Designer mode** distilled from [`huashu-design`](https://github.com/alchaincyf/huashu-design): batch the questions up front, show something visible early (even a wireframe with grey blocks), let the user redirect cheaply. Combined with the brand-asset protocol (locate · download · `grep` hex · write `brand-spec.md` · vocalise), it's the single biggest reason output stops feeling like AI freestyle and starts feeling like a designer who paid attention before painting.
|
|
241
|
+
|
|
242
|
+
### 5 · The daemon makes the agent feel like it's on your laptop, because it is.
|
|
243
|
+
|
|
244
|
+
The daemon spawns the CLI with `cwd` set to the project's artifact folder under `.od/projects/<id>/`. The agent gets `Read`, `Write`, `Bash`, `WebFetch` — real tools against a real filesystem. It can `Read` the skill's `assets/template.html`, `grep` your CSS for hex values, write a `brand-spec.md`, drop generated images, and produce `.pptx` / `.zip` / `.pdf` files that show up in the file workspace as download chips when the turn ends. Sessions, conversations, messages, tabs persist in a local SQLite DB — pop the project open tomorrow and the agent's todo card is right where you left it.
|
|
245
|
+
|
|
246
|
+
### 6 · The prompt stack is the product.
|
|
247
|
+
|
|
248
|
+
What you compose at send time isn't "system + user". It's:
|
|
249
|
+
|
|
250
|
+
```
|
|
251
|
+
DISCOVERY directives (turn-1 form, turn-2 brand branch, TodoWrite, 5-dim critique)
|
|
252
|
+
+ identity charter (OFFICIAL_DESIGNER_PROMPT, anti-AI-slop, junior-pass)
|
|
253
|
+
+ active DESIGN.md (72 systems available)
|
|
254
|
+
+ active SKILL.md (31 skills available)
|
|
255
|
+
+ project metadata (kind, fidelity, speakerNotes, animations, inspiration ids)
|
|
256
|
+
+ skill side files (auto-injected pre-flight: read assets/template.html + references/*.md)
|
|
257
|
+
+ (deck kind, no skill seed) DECK_FRAMEWORK_DIRECTIVE (nav / counter / scroll / print)
|
|
258
|
+
```
|
|
259
|
+
|
|
260
|
+
Every layer is composable. Every layer is a file you can edit. Read [`apps/daemon/src/prompts/system.ts`](apps/daemon/src/prompts/system.ts) and [`apps/daemon/src/prompts/discovery.ts`](apps/daemon/src/prompts/discovery.ts) to see the actual contract.
|
|
261
|
+
|
|
262
|
+
## Architecture
|
|
263
|
+
|
|
264
|
+
```
|
|
265
|
+
┌────────────────────── browser (Next.js 16) ──────────────────────┐
|
|
266
|
+
│ chat · file workspace · iframe preview · settings · imports │
|
|
267
|
+
└──────────────┬───────────────────────────────────┬───────────────┘
|
|
268
|
+
│ /api/* (rewritten in dev) │
|
|
269
|
+
▼ ▼
|
|
270
|
+
┌──────────────────────────────────┐ /api/proxy/{provider}/stream (SSE)
|
|
271
|
+
│ Local daemon (Express + SQLite) │ ─→ any OpenAI-compat
|
|
272
|
+
│ │ endpoint (BYOK)
|
|
273
|
+
│ /api/agents /api/skills│ w/ SSRF blocking
|
|
274
|
+
│ /api/design-systems /api/projects/…
|
|
275
|
+
│ /api/chat (SSE) /api/proxy/{provider}/stream (SSE)
|
|
276
|
+
│ /api/templates /api/import/claude-design
|
|
277
|
+
│ /api/artifacts/save /api/artifacts/lint
|
|
278
|
+
│ /api/upload /api/projects/:id/files…
|
|
279
|
+
│ /artifacts (static) /frames (static)
|
|
280
|
+
│
|
|
281
|
+
│ optional: sidecar IPC at /tmp/open-design/ipc/<ns>/<app>.sock
|
|
282
|
+
│ (STATUS · EVAL · SCREENSHOT · CONSOLE · CLICK · SHUTDOWN)
|
|
283
|
+
└─────────┬────────────────────────┘
|
|
284
|
+
│ spawn(cli, [...], { cwd: .od/projects/<id> })
|
|
285
|
+
▼
|
|
286
|
+
┌──────────────────────────────────────────────────────────────────┐
|
|
287
|
+
│ claude · codex · devin (ACP) · gemini · opencode · cursor-agent │
|
|
288
|
+
│ qwen · qoder · copilot · hermes (ACP) · kimi (ACP) · pi (RPC) · kiro (ACP) · kilo (ACP) · vibe (ACP) · deepseek │
|
|
289
|
+
│ reads SKILL.md + DESIGN.md, writes artifacts to disk │
|
|
290
|
+
└──────────────────────────────────────────────────────────────────┘
|
|
291
|
+
```
|
|
292
|
+
|
|
293
|
+
| Layer | Stack |
|
|
294
|
+
|---|---|
|
|
295
|
+
| Frontend | Next.js 16 App Router + React 18 + TypeScript, Vercel-deployable |
|
|
296
|
+
| Daemon | Node 24 · Express · SSE streaming · `better-sqlite3`; tables: `projects` · `conversations` · `messages` · `tabs` · `templates` |
|
|
297
|
+
| Agent transport | `child_process.spawn`; typed-event parsers for `claude-stream-json` (Claude Code), `qoder-stream-json` (Qoder CLI), `copilot-stream-json` (Copilot), `json-event-stream` per-CLI parsers (Codex / Gemini / OpenCode / Cursor Agent), `acp-json-rpc` (Devin / Hermes / Kimi / Kiro / Kilo / Mistral Vibe via Agent Client Protocol), `pi-rpc` (Pi via stdio JSON-RPC), `plain` (Qwen Code / DeepSeek TUI) |
|
|
298
|
+
| BYOK proxy | `POST /api/proxy/{anthropic,openai,azure,google}/stream` → provider-specific upstream APIs, normalized `delta/end/error` SSE; allows loopback local LLM providers, rejects non-loopback private/link-local/CGNAT/multicast/reserved hosts, and disables upstream redirects at the daemon edge |
|
|
299
|
+
| Storage | Plain files in `.od/projects/<id>/` + SQLite at `.od/app.sqlite` + credentials at `.od/media-config.json` (gitignored, auto-created). `OD_DATA_DIR=<dir>` relocates all daemon data (used for test isolation and read-only-install setups); `OD_MEDIA_CONFIG_DIR=<dir>` further narrows the override to just `media-config.json` for setups that want to keep API keys outside the data dir |
|
|
300
|
+
| Preview | Sandboxed iframe via `srcdoc` + per-skill `<artifact>` parser ([`apps/web/src/artifacts/parser.ts`](apps/web/src/artifacts/parser.ts)) |
|
|
301
|
+
| Export | HTML (inline assets) · PDF (browser print, deck-aware) · PPTX (agent-driven via skill) · ZIP (archiver) · Markdown |
|
|
302
|
+
| Lifecycle | `pnpm tools-dev start \| stop \| run \| status \| logs \| inspect \| check`; ports via `--daemon-port` / `--web-port`, namespaces via `--namespace` |
|
|
303
|
+
| Desktop (optional) | Electron shell — discovers the web URL through sidecar IPC, no port guessing; same `STATUS`/`EVAL`/`SCREENSHOT`/`CONSOLE`/`CLICK`/`SHUTDOWN` channel powers `tools-dev inspect desktop …` for E2E |
|
|
304
|
+
|
|
305
|
+
## Quickstart
|
|
306
|
+
|
|
307
|
+
### Download the desktop app (no build required)
|
|
308
|
+
|
|
309
|
+
The fastest way to try Open Design is the prebuilt desktop app — no Node, no pnpm, no clone:
|
|
310
|
+
|
|
311
|
+
- **[open-design.ai](https://open-design.ai/)** — official download page
|
|
312
|
+
- **[GitHub releases](https://github.com/nexu-io/open-design/releases)**
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
### Run with Docker
|
|
316
|
+
|
|
317
|
+
Run Open Design without installing Node.js or pnpm locally.
|
|
318
|
+
|
|
319
|
+
#### Requirements
|
|
320
|
+
|
|
321
|
+
* Docker Desktop
|
|
322
|
+
* Docker Compose v2
|
|
323
|
+
|
|
324
|
+
Verify Docker:
|
|
325
|
+
|
|
326
|
+
```bash id="70jv9o"
|
|
327
|
+
docker compose version
|
|
328
|
+
```
|
|
329
|
+
|
|
330
|
+
#### Start Open Design
|
|
331
|
+
|
|
332
|
+
```bash id="m9w43w"
|
|
333
|
+
git clone https://github.com/nexu-io/open-design.git
|
|
334
|
+
cd open-design/deploy
|
|
335
|
+
docker compose up -d
|
|
336
|
+
```
|
|
337
|
+
|
|
338
|
+
Open in your browser:
|
|
339
|
+
|
|
340
|
+
```text id="4s4xeh"
|
|
341
|
+
http://localhost:7456
|
|
342
|
+
```
|
|
343
|
+
|
|
344
|
+
#### Common Commands
|
|
345
|
+
|
|
346
|
+
```bash id="gl95kp"
|
|
347
|
+
# View logs
|
|
348
|
+
docker compose logs -f
|
|
349
|
+
|
|
350
|
+
# Restart containers
|
|
351
|
+
docker compose restart
|
|
352
|
+
|
|
353
|
+
# Stop containers
|
|
354
|
+
docker compose down
|
|
355
|
+
|
|
356
|
+
# Pull latest image
|
|
357
|
+
docker compose pull
|
|
358
|
+
docker compose up -d
|
|
359
|
+
```
|
|
360
|
+
|
|
361
|
+
For advanced Docker configuration and environment variables, see [`QUICKSTART.md`](QUICKSTART.md).
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
### Run from source
|
|
366
|
+
|
|
367
|
+
```bash
|
|
368
|
+
git clone https://github.com/nexu-io/open-design.git
|
|
369
|
+
cd open-design
|
|
370
|
+
corepack enable
|
|
371
|
+
corepack pnpm --version # should print 10.33.2
|
|
372
|
+
pnpm install
|
|
373
|
+
pnpm tools-dev run web
|
|
374
|
+
# open the web URL printed by tools-dev
|
|
375
|
+
```
|
|
376
|
+
|
|
377
|
+
Environment requirements: Node `~24` and pnpm `10.33.x`. `nvm`/`fnm` are optional helpers only; if you use one, run `nvm install 24 && nvm use 24` or `fnm install 24 && fnm use 24` before `pnpm install`.
|
|
378
|
+
|
|
379
|
+
Windows users can follow [`docs/windows-troubleshooting.md`](docs/windows-troubleshooting.md) for the native setup path and a tiny double-click launcher.
|
|
380
|
+
|
|
381
|
+
For desktop/background startup, fixed-port restarts, and media generation dispatcher checks (`OD_BIN`, `OD_DAEMON_URL`, `apps/daemon/dist/cli.js`), see [`QUICKSTART.md`](QUICKSTART.md).
|
|
382
|
+
|
|
383
|
+
The first load:
|
|
384
|
+
|
|
385
|
+
1. Detects which agent CLIs you have on `PATH` and picks one automatically.
|
|
386
|
+
2. Loads 31 skills + 72 design systems.
|
|
387
|
+
3. Pops the welcome dialog so you can paste an Anthropic key (only needed for the BYOK fallback path).
|
|
388
|
+
4. **Auto-creates `./.od/`** — the local runtime folder for the SQLite project DB, per-project artifacts, and saved renders. There is no `od init` step; the daemon `mkdir`s everything it needs on boot.
|
|
389
|
+
|
|
390
|
+
Type a prompt, hit **Send**, watch the question form arrive, fill it, watch the todo card stream, watch the artifact render. Click **Save to disk** or download as a project ZIP.
|
|
391
|
+
|
|
392
|
+
### First-run state (`./.od/`)
|
|
393
|
+
|
|
394
|
+
The daemon owns one hidden folder at the repo root. Everything in it is gitignored and machine-local — never commit it.
|
|
395
|
+
|
|
396
|
+
```
|
|
397
|
+
.od/
|
|
398
|
+
├── app.sqlite ← projects · conversations · messages · open tabs
|
|
399
|
+
├── artifacts/ ← one-off "Save to disk" renders (timestamped)
|
|
400
|
+
└── projects/<id>/ ← per-project working dir, also the agent's cwd
|
|
401
|
+
```
|
|
402
|
+
|
|
403
|
+
| Want to… | Do this |
|
|
404
|
+
|---|---|
|
|
405
|
+
| Inspect what's in there | `ls -la .od && sqlite3 .od/app.sqlite '.tables'` |
|
|
406
|
+
| Reset to a clean slate | `pnpm tools-dev stop`, `rm -rf .od`, run `pnpm tools-dev run web` again |
|
|
407
|
+
| Move it elsewhere | `OD_DATA_DIR=<absolute-or-relative-path> pnpm tools-dev run web` — the daemon resolves `~/` and anchors relative paths to the repo root. `OD_MEDIA_CONFIG_DIR=<dir>` narrows the override to just `media-config.json` if you want credentials in a separate location. |
|
|
408
|
+
|
|
409
|
+
#### Migrating a pre-desktop-app `.od/` into the installed Desktop app
|
|
410
|
+
|
|
411
|
+
If you ran the repo first and only later installed the packaged Desktop app, the two writers point at different roots:
|
|
412
|
+
|
|
413
|
+
- Repo dev-server (`pnpm tools-dev start web`) writes to `<repo-root>/.od/`.
|
|
414
|
+
- Installed Desktop app writes under `<appData>/Open Design/namespaces/<channel>/data/`, where `<appData>` is Electron's per-OS app-data base (everything before the `Open Design` segment that `app.getPath("userData")` already includes). The channel suffix is **platform-specific** — the release workflows append `-win`/`-linux`:
|
|
415
|
+
|
|
416
|
+
| Platform | `<appData>` (Electron `appData` base) | Stable channel | Beta channel |
|
|
417
|
+
|---|---|---|---|
|
|
418
|
+
| macOS | `~/Library/Application Support` | `release-stable` | `release-beta` |
|
|
419
|
+
| Windows | `%APPDATA%` (= `%USERPROFILE%\AppData\Roaming`) | `release-stable-win` | `release-beta-win` |
|
|
420
|
+
| Linux | `$XDG_CONFIG_HOME` (default `~/.config`) | `release-stable-linux` | `release-beta-linux` |
|
|
421
|
+
|
|
422
|
+
Example resolved paths:
|
|
423
|
+
- macOS beta: `~/Library/Application Support/Open Design/namespaces/release-beta/data/`
|
|
424
|
+
- Windows beta: `%APPDATA%\Open Design\namespaces\release-beta-win\data\`
|
|
425
|
+
- Linux beta: `~/.config/Open Design/namespaces/release-beta-linux/data/`
|
|
426
|
+
|
|
427
|
+
If unsure, inspect the packaged daemon log right after the app boots; it logs the resolved `daemonDataRoot`.
|
|
428
|
+
|
|
429
|
+
> **⚠️ Do this in a clean state.** Migration replaces (not merges) the Desktop app's data dir with your repo `.od/`. Both writers must be fully stopped before copying — quit the Desktop app **and** stop the repo dev-server. SQLite-WAL needs to flush cleanly on both sides; if either daemon is still running it can write SQLite/WAL pages or project/artifact files mid-snapshot, leaving the staged copy inconsistent. If the Desktop app already has projects you care about, decide which side is authoritative before continuing — the steps below back up the Desktop's current `data/` to a sibling but do not merge.
|
|
430
|
+
|
|
431
|
+
##### Option A: one-shot auto-migration via `OD_LEGACY_DATA_DIR`
|
|
432
|
+
|
|
433
|
+
Use this when the Desktop app's `data/` is still empty, which is the typical state right after the upgrade that surfaced [#710](https://github.com/nexu-io/open-design/issues/710). Quit the Desktop app first (so its daemon is not holding `app.sqlite`), then re-launch with `OD_LEGACY_DATA_DIR` pointed at your old repo `.od/`. The daemon stages your payload into a sibling tmp directory and only promotes it into `data/` on success; on any failure the staging directory is removed so the next boot retries cleanly.
|
|
434
|
+
|
|
435
|
+
The daemon refuses, with a visible startup error, when:
|
|
436
|
+
|
|
437
|
+
- the path in `OD_LEGACY_DATA_DIR` does not contain `app.sqlite` (typo, deleted source, wrong path), or
|
|
438
|
+
- the Desktop's `data/` already contains any of `app.sqlite`, `projects/`, `artifacts/`, `media-config.json`, etc. SQLite/WAL pairs and project trees cannot be safely interleaved, so the daemon refuses to merge instead of silently corrupting either side. If the Desktop has already booted and seeded its own `data/`, use Option B and decide explicitly which side wins.
|
|
439
|
+
|
|
440
|
+
A `.migrated-from` marker is written on success so subsequent boots no-op.
|
|
441
|
+
|
|
442
|
+
Quit the Desktop app first, then re-launch with this env set. The launcher must put the variable into the *app process* environment, not just the shell that runs `open` / `xdg-open`.
|
|
443
|
+
|
|
444
|
+
**macOS** (LaunchServices does not inherit shell env, so use the direct binary):
|
|
445
|
+
|
|
446
|
+
```bash
|
|
447
|
+
OD_LEGACY_DATA_DIR="/path/to/old/repo/.od" \
|
|
448
|
+
"/Applications/Open Design.app/Contents/MacOS/Open Design"
|
|
449
|
+
```
|
|
450
|
+
|
|
451
|
+
If you prefer the Dock launcher, set the variable in `launchctl` first, open the app, then unset it:
|
|
452
|
+
|
|
453
|
+
```bash
|
|
454
|
+
launchctl setenv OD_LEGACY_DATA_DIR "/path/to/old/repo/.od"
|
|
455
|
+
open "/Applications/Open Design.app"
|
|
456
|
+
# After the migration log line appears:
|
|
457
|
+
launchctl unsetenv OD_LEGACY_DATA_DIR
|
|
458
|
+
```
|
|
459
|
+
|
|
460
|
+
**Linux** (run the binary directly so the env var actually reaches it):
|
|
461
|
+
|
|
462
|
+
```bash
|
|
463
|
+
OD_LEGACY_DATA_DIR="/path/to/old/repo/.od" /path/to/open-design
|
|
464
|
+
# (e.g. the AppImage you launched, or the unpacked binary under /opt)
|
|
465
|
+
```
|
|
466
|
+
|
|
467
|
+
**Windows (PowerShell):**
|
|
468
|
+
|
|
469
|
+
```powershell
|
|
470
|
+
$env:OD_LEGACY_DATA_DIR="C:\path\to\old\repo\.od"
|
|
471
|
+
& "$env:LOCALAPPDATA\Programs\Open Design\Open Design.exe"
|
|
472
|
+
```
|
|
473
|
+
|
|
474
|
+
The daemon log records `[od-migrate] migration complete: copied N entries (...)`. After the first launch you can clear the env variable; the marker prevents re-migration even on subsequent runs.
|
|
475
|
+
|
|
476
|
+
##### Option B: manual copy
|
|
477
|
+
|
|
478
|
+
To carry your existing projects, SQLite, artifacts, and `media-config.json` over to the Desktop app, when Option A is not viable (Desktop already has its own data and you want to replace it explicitly).
|
|
479
|
+
|
|
480
|
+
**macOS / Linux (bash):**
|
|
481
|
+
|
|
482
|
+
```bash
|
|
483
|
+
set -euo pipefail
|
|
484
|
+
# 1. Stop both writers so the source and target are quiescent.
|
|
485
|
+
# - Quit the Desktop app (Cmd+Q on macOS, File → Exit on Linux).
|
|
486
|
+
# - Stop the repo dev-server: `pnpm tools-dev stop` from the repo root.
|
|
487
|
+
# 2. Set REPO and APP_DATA to your actual paths; the example below is macOS + beta.
|
|
488
|
+
REPO="/path/to/open-design"
|
|
489
|
+
APP_DATA="$HOME/Library/Application Support/Open Design/namespaces/release-beta/data"
|
|
490
|
+
|
|
491
|
+
# 3. Preflight: see what (if anything) the Desktop app already has.
|
|
492
|
+
ls "$APP_DATA/projects" 2>/dev/null && echo "Desktop already has projects, confirm this is a replace, not a merge."
|
|
493
|
+
|
|
494
|
+
# 4. Stage into a sibling first, then atomically swap into place. `set -e` plus
|
|
495
|
+
# the explicit rsync exit check guarantee a non-zero copy aborts before any
|
|
496
|
+
# `mv` runs, so the Desktop data dir cannot end up half-populated.
|
|
497
|
+
STAGE="${APP_DATA}.staged-$(date +%F-%H%M)"
|
|
498
|
+
mkdir -p "$STAGE"
|
|
499
|
+
rsync -a --exclude='backup-*' "$REPO/.od/" "$STAGE/" || { echo "rsync failed, aborting before swap"; exit 1; }
|
|
500
|
+
|
|
501
|
+
# 5. Backup the Desktop's current data, then promote the staged copy.
|
|
502
|
+
mv "$APP_DATA" "${APP_DATA}.fresh-baseline-$(date +%F-%H%M)"
|
|
503
|
+
mv "$STAGE" "$APP_DATA"
|
|
504
|
+
|
|
505
|
+
# 6. Relaunch the Desktop app. The daemon applies forward schema changes on boot.
|
|
506
|
+
```
|
|
507
|
+
|
|
508
|
+
**Windows (PowerShell):**
|
|
509
|
+
|
|
510
|
+
```powershell
|
|
511
|
+
$ErrorActionPreference = 'Stop'
|
|
512
|
+
# 1. Stop both writers so the source and target are quiescent.
|
|
513
|
+
# - Quit the Desktop app (File > Exit).
|
|
514
|
+
# - Stop the repo dev-server: `pnpm tools-dev stop` from the repo root.
|
|
515
|
+
# 2. Set $Repo and $AppData to your actual paths; the example below is stable channel.
|
|
516
|
+
$Repo = 'C:\path\to\open-design'
|
|
517
|
+
$AppData = Join-Path $env:APPDATA 'Open Design\namespaces\release-stable-win\data'
|
|
518
|
+
|
|
519
|
+
# 3. Preflight: see what (if anything) the Desktop app already has.
|
|
520
|
+
if (Test-Path (Join-Path $AppData 'projects')) {
|
|
521
|
+
Write-Host 'Desktop already has projects, confirm this is a replace, not a merge.'
|
|
522
|
+
}
|
|
523
|
+
|
|
524
|
+
# 4. Stage into a sibling first. Robocopy /MIR mirrors source to staging, and
|
|
525
|
+
# its exit codes >= 8 are real errors (0..7 are success/info), so we guard
|
|
526
|
+
# explicitly before promoting.
|
|
527
|
+
$Stamp = Get-Date -Format 'yyyy-MM-dd-HHmm'
|
|
528
|
+
$Stage = "$AppData.staged-$Stamp"
|
|
529
|
+
robocopy "$Repo\.od" $Stage /MIR /XD 'backup-*' | Out-Null
|
|
530
|
+
if ($LASTEXITCODE -ge 8) { throw "robocopy failed (exit $LASTEXITCODE), aborting before swap" }
|
|
531
|
+
|
|
532
|
+
# 5. Backup the Desktop's current data, then promote the staged copy.
|
|
533
|
+
if (Test-Path $AppData) { Rename-Item $AppData "$AppData.fresh-baseline-$Stamp" }
|
|
534
|
+
Rename-Item $Stage $AppData
|
|
535
|
+
|
|
536
|
+
# 6. Relaunch the Desktop app. The daemon applies forward schema changes on boot.
|
|
537
|
+
```
|
|
538
|
+
|
|
539
|
+
If anything looks wrong after relaunch, restore the original Desktop data by deleting `$APP_DATA` (or `$AppData` on Windows) and renaming the `.fresh-baseline-*` directory back into place.
|
|
540
|
+
|
|
541
|
+
> **⚠️ Schema migrations are forward-only.** The daemon applies `CREATE TABLE IF NOT EXISTS` / `ALTER TABLE` changes on boot; there is no version guard. After migrating, **do not** open the same data dir with an older repo checkout — unsupported columns or behavior mismatches can leave the workspace inconsistent. Back up `app.sqlite*` before the first launch with the new app.
|
|
542
|
+
|
|
543
|
+
> **⚠️ Advanced: sharing one data dir between repo dev-server and Desktop app.** Pointing both at the same dir via `OD_DATA_DIR` is possible but **only safe one-at-a-time**. The daemon opens `app.sqlite` in WAL mode and writes uncoordinated files under `projects/` and `artifacts/`; running both writers concurrently can corrupt SQLite or clobber artifacts. Always stop the Desktop app before starting the dev-server, and stop the dev-server before opening the Desktop app:
|
|
544
|
+
>
|
|
545
|
+
> ```bash
|
|
546
|
+
> OD_DATA_DIR="$HOME/Library/Application Support/Open Design/namespaces/release-beta/data" \
|
|
547
|
+
> pnpm tools-dev start web
|
|
548
|
+
> ```
|
|
549
|
+
|
|
550
|
+
Full file map, scripts, and troubleshooting → [`QUICKSTART.md`](QUICKSTART.md).
|
|
551
|
+
|
|
552
|
+
## Running the Project
|
|
553
|
+
|
|
554
|
+
Open Design can run as a web app in your browser or as an Electron desktop application. Both modes share the same local daemon + web architecture.
|
|
555
|
+
|
|
556
|
+
### Web / Localhost (Default)
|
|
557
|
+
|
|
558
|
+
```bash
|
|
559
|
+
# Foreground mode — keeps the lifecycle command in the foreground (logs written to files)
|
|
560
|
+
pnpm tools-dev run web
|
|
561
|
+
|
|
562
|
+
# View recent logs:
|
|
563
|
+
pnpm tools-dev logs
|
|
564
|
+
|
|
565
|
+
# Background mode — daemon + web run as background processes
|
|
566
|
+
pnpm tools-dev start web
|
|
567
|
+
```
|
|
568
|
+
|
|
569
|
+
By default, `tools-dev` binds to available ephemeral ports and prints the actual URLs on startup. To use fixed ports from a stopped state:
|
|
570
|
+
|
|
571
|
+
```bash
|
|
572
|
+
pnpm tools-dev run web --daemon-port 17456 --web-port 17573
|
|
573
|
+
```
|
|
574
|
+
|
|
575
|
+
If daemon/web are already running, use `restart` to switch ports in the existing session:
|
|
576
|
+
|
|
577
|
+
```bash
|
|
578
|
+
pnpm tools-dev restart --daemon-port 17456 --web-port 17573
|
|
579
|
+
```
|
|
580
|
+
|
|
581
|
+
### Desktop / Electron
|
|
582
|
+
|
|
583
|
+
```bash
|
|
584
|
+
# Start daemon + web + desktop in the background
|
|
585
|
+
pnpm tools-dev
|
|
586
|
+
|
|
587
|
+
# Check desktop status
|
|
588
|
+
pnpm tools-dev inspect desktop status
|
|
589
|
+
|
|
590
|
+
# Take a screenshot of the desktop app
|
|
591
|
+
pnpm tools-dev inspect desktop screenshot --path /tmp/open-design.png
|
|
592
|
+
```
|
|
593
|
+
|
|
594
|
+
The desktop app discovers the web URL automatically via sidecar IPC — no port guessing required.
|
|
595
|
+
|
|
596
|
+
### Other Useful Commands
|
|
597
|
+
|
|
598
|
+
| Command | What it does |
|
|
599
|
+
|---|---|
|
|
600
|
+
| `pnpm tools-dev status` | Show running sidecar statuses |
|
|
601
|
+
| `pnpm tools-dev logs` | Show daemon/web/desktop log tails |
|
|
602
|
+
| `pnpm tools-dev stop` | Stop all running sidecars |
|
|
603
|
+
| `pnpm tools-dev restart` | Stop then restart all sidecars |
|
|
604
|
+
| `pnpm tools-dev check` | Status + recent logs + common diagnostics |
|
|
605
|
+
|
|
606
|
+
For fixed-port restarts, background startup, and full troubleshooting see [`QUICKSTART.md`](QUICKSTART.md).
|
|
607
|
+
|
|
608
|
+
## Nix
|
|
609
|
+
|
|
610
|
+
A flake is published at the repo root. Home Manager is the recommended path for individual developers; a NixOS module is also exposed for shared/server installs. See [`nix/README.md`](nix/README.md) for the full surface (data dir, secrets, `webFrontend` vs. bringing your own server, `OD_DAEMON_URL`).
|
|
611
|
+
|
|
612
|
+
```nix
|
|
613
|
+
# Home Manager
|
|
614
|
+
inputs.open-design.url = "github:nexu-io/open-design";
|
|
615
|
+
# then: imports = [ inputs.open-design.homeManagerModules.default ];
|
|
616
|
+
```
|
|
617
|
+
|
|
618
|
+
```bash
|
|
619
|
+
nix run github:nexu-io/open-design # boot the daemon (`od`) without installing
|
|
620
|
+
```
|
|
621
|
+
|
|
622
|
+
For developers, a Nix dev shell is available and can be used with `direnv` too:
|
|
623
|
+
|
|
624
|
+
```bash
|
|
625
|
+
nix develop # dev shell with required dependencies to work on Open Design
|
|
626
|
+
```
|
|
627
|
+
|
|
628
|
+
|
|
629
|
+
## Use Open Design from your coding agent
|
|
630
|
+
|
|
631
|
+
Open Design ships a stdio MCP server. Wire it into Claude Code, Codex, Cursor, VS Code, Antigravity, Zed, Windsurf, or any MCP-compatible client and the agent in another repo can read files from your local Open Design projects directly. Replaces the export-then-attach loop. When the agent calls `search_files`, `get_file`, or `get_artifact` without a project argument, the MCP defaults to whatever project (and file) you have open in Open Design right now, so prompts like *"build this in my app"* or *"match these styles"* just work.
|
|
632
|
+
|
|
633
|
+
**Why MCP?** Exporting and re-attaching a zip every design iteration breaks flow. The MCP server exposes your design source directly -- tokens CSS, JSX components, entry HTML -- as a structured API the agent can query by name. The agent always sees the live file, not a stale copy from the last export.
|
|
634
|
+
|
|
635
|
+
Open **Settings → MCP server** in the Open Design app for a per-client install flow. The panel bakes the absolute path to your `node` binary and the daemon's built `cli.js` into every snippet, so it works on a fresh source clone where `od` is not on your PATH. Cursor gets a one-click deeplink; the rest get a copy-paste JSON snippet in the schema their config file expects (Claude Code includes a `claude mcp add-json` one-liner so you do not have to hand-edit `~/.claude.json`). Restart or reload your client after install for the server to show up.
|
|
636
|
+
|
|
637
|
+
The daemon must be running locally for MCP tool calls to succeed. If the agent was started before Open Design, restart the agent after Open Design is up so it can reach the live daemon. Tool calls made while the daemon is offline return a clear `"daemon not reachable"` error rather than a crash.
|
|
638
|
+
|
|
639
|
+
**Security model.** The MCP server is read-only; it exposes file reads, file metadata, and search -- nothing that writes to disk or calls an external service. It runs as a child process of the coding agent over stdio, so any MCP client you register inherits read access to your local Open Design projects. Treat it like installing a VS Code extension: only register clients you trust. The daemon binds to `127.0.0.1` by default; LAN-wide exposure requires an explicit `OD_BIND_HOST` opt-in. If you also front the SPA with a non-loopback static server, set `OD_ALLOWED_ORIGINS=<origin1>,<origin2>,...` (comma-separated `scheme://host[:port]` entries) so the daemon's same-origin gate accepts API writes from those origins on both the `Origin` and `Host` checks; without it the browser will see 403s on every PUT/POST (Caddy v2 reverse_proxy preserves the original Host header upstream by default, so loopback alone is not enough). Connector-credential and live-artifact preview routes stay loopback-only regardless.
|
|
640
|
+
|
|
641
|
+
## Repository structure
|
|
642
|
+
|
|
643
|
+
```
|
|
644
|
+
open-design/
|
|
645
|
+
├── README.md ← this file
|
|
646
|
+
├── README.de.md ← Deutsch
|
|
647
|
+
├── README.ru.md ← Русский
|
|
648
|
+
├── README.zh-CN.md ← 简体中文
|
|
649
|
+
├── QUICKSTART.md ← run / build / deploy guide
|
|
650
|
+
├── package.json ← pnpm workspace, single bin: od
|
|
651
|
+
│
|
|
652
|
+
├── apps/
|
|
653
|
+
│ ├── daemon/ ← Node + Express, the only server
|
|
654
|
+
│ │ ├── src/ ← TypeScript daemon source
|
|
655
|
+
│ │ │ ├── cli.ts ← `od` bin source, compiled to dist/cli.js
|
|
656
|
+
│ │ │ ├── server.ts ← /api/* routes (projects, chat, files, exports)
|
|
657
|
+
│ │ │ ├── agents.ts ← PATH scanner + per-CLI argv builders
|
|
658
|
+
│ │ │ ├── claude-stream.ts ← streaming JSON parser for Claude Code stdout
|
|
659
|
+
│ │ │ ├── skills.ts ← SKILL.md frontmatter loader
|
|
660
|
+
│ │ │ └── db.ts ← SQLite schema (projects/messages/templates/tabs)
|
|
661
|
+
│ │ ├── sidecar/ ← tools-dev daemon sidecar wrapper
|
|
662
|
+
│ │ └── tests/ ← daemon package tests
|
|
663
|
+
│ │
|
|
664
|
+
│ └── web/ ← Next.js 16 App Router + React client
|
|
665
|
+
│ ├── app/ ← App Router entrypoints
|
|
666
|
+
│ ├── next.config.ts ← dev rewrites + prod static export to out/
|
|
667
|
+
│ └── src/ ← React + TypeScript client modules
|
|
668
|
+
│ ├── App.tsx ← routing, bootstrap, settings
|
|
669
|
+
│ ├── components/ ← chat, composer, picker, preview, sketch, …
|
|
670
|
+
│ ├── prompts/
|
|
671
|
+
│ │ ├── system.ts ← composeSystemPrompt(base, skill, DS, metadata)
|
|
672
|
+
│ │ ├── discovery.ts ← turn-1 form + turn-2 branch + 5-dim critique
|
|
673
|
+
│ │ └── directions.ts ← 5 visual directions × OKLch palette + font stack
|
|
674
|
+
│ ├── artifacts/ ← streaming <artifact> parser + manifests
|
|
675
|
+
│ ├── runtime/ ← iframe srcdoc, markdown, export helpers
|
|
676
|
+
│ ├── providers/ ← daemon SSE + BYOK API transports
|
|
677
|
+
│ └── state/ ← config + projects (localStorage + daemon-backed)
|
|
678
|
+
│
|
|
679
|
+
├── e2e/ ← Playwright UI + external integration/Vitest harness
|
|
680
|
+
│
|
|
681
|
+
├── packages/
|
|
682
|
+
│ ├── contracts/ ← shared web/daemon app contracts
|
|
683
|
+
│ ├── sidecar-proto/ ← Open Design sidecar protocol contract
|
|
684
|
+
│ ├── sidecar/ ← generic sidecar runtime primitives
|
|
685
|
+
│ └── platform/ ← generic process/platform primitives
|
|
686
|
+
│
|
|
687
|
+
├── skills/ ← 31 SKILL.md skill bundles (27 prototype + 4 deck)
|
|
688
|
+
│ ├── web-prototype/ ← default for prototype mode
|
|
689
|
+
│ ├── saas-landing/ dashboard/ pricing-page/ docs-page/ blog-post/
|
|
690
|
+
│ ├── mobile-app/ mobile-onboarding/ gamified-app/
|
|
691
|
+
│ ├── email-marketing/ social-carousel/ magazine-poster/
|
|
692
|
+
│ ├── motion-frames/ sprite-animation/ digital-eguide/ dating-web/
|
|
693
|
+
│ ├── critique/ tweaks/ wireframe-sketch/
|
|
694
|
+
│ ├── pm-spec/ team-okrs/ meeting-notes/ kanban-board/
|
|
695
|
+
│ ├── eng-runbook/ finance-report/ invoice/ hr-onboarding/
|
|
696
|
+
│ ├── simple-deck/ replit-deck/ weekly-update/ ← deck mode
|
|
697
|
+
│ └── guizang-ppt/ ← bundled magazine-web-ppt (default for deck)
|
|
698
|
+
│ ├── SKILL.md
|
|
699
|
+
│ ├── assets/template.html ← seed
|
|
700
|
+
│ └── references/{themes,layouts,components,checklist}.md
|
|
701
|
+
│
|
|
702
|
+
├── design-systems/ ← 72 DESIGN.md systems
|
|
703
|
+
│ ├── default/ ← Neutral Modern (starter)
|
|
704
|
+
│ ├── warm-editorial/ ← Warm Editorial (starter)
|
|
705
|
+
│ ├── linear-app/ vercel/ stripe/ airbnb/ notion/ cursor/ apple/ …
|
|
706
|
+
│ └── README.md ← catalog overview
|
|
707
|
+
│
|
|
708
|
+
├── assets/
|
|
709
|
+
│ └── frames/ ← shared device frames (used cross-skill)
|
|
710
|
+
│ ├── iphone-15-pro.html
|
|
711
|
+
│ ├── android-pixel.html
|
|
712
|
+
│ ├── ipad-pro.html
|
|
713
|
+
│ ├── macbook.html
|
|
714
|
+
│ └── browser-chrome.html
|
|
715
|
+
│
|
|
716
|
+
├── templates/
|
|
717
|
+
│ ├── deck-framework.html ← deck baseline (nav / counter / print)
|
|
718
|
+
│ └── kami-deck.html ← kami-flavored deck starter (parchment / ink-blue serif)
|
|
719
|
+
│
|
|
720
|
+
├── scripts/
|
|
721
|
+
│ └── sync-design-systems.ts ← re-import upstream awesome-design-md tarball
|
|
722
|
+
│
|
|
723
|
+
├── docs/
|
|
724
|
+
│ ├── spec.md ← product spec, scenarios, differentiation
|
|
725
|
+
│ ├── architecture.md ← topologies, data flow, components
|
|
726
|
+
│ ├── skills-protocol.md ← extended SKILL.md od: frontmatter
|
|
727
|
+
│ ├── agent-adapters.md ← per-CLI detection + dispatch
|
|
728
|
+
│ ├── modes.md ← prototype / deck / template / design-system
|
|
729
|
+
│ ├── references.md ← long-form provenance
|
|
730
|
+
│ ├── roadmap.md ← phased delivery
|
|
731
|
+
│ ├── schemas/ ← JSON schemas
|
|
732
|
+
│ └── examples/ ← canonical artifact examples
|
|
733
|
+
│
|
|
734
|
+
└── .od/ ← runtime data, gitignored, auto-created
|
|
735
|
+
├── app.sqlite ← projects / conversations / messages / tabs
|
|
736
|
+
├── projects/<id>/ ← per-project working folder (agent's cwd)
|
|
737
|
+
└── artifacts/ ← saved one-off renders
|
|
738
|
+
```
|
|
739
|
+
|
|
740
|
+
## Design Systems
|
|
741
|
+
|
|
742
|
+
<p align="center">
|
|
743
|
+
<img src="docs/assets/design-systems-library.png" alt="The 72 design systems library — style guide spread" width="100%" />
|
|
744
|
+
</p>
|
|
745
|
+
|
|
746
|
+
72 systems out of the box, each as a single [`DESIGN.md`](design-systems/README.md):
|
|
747
|
+
|
|
748
|
+
<details>
|
|
749
|
+
<summary><b>Full catalog</b> (click to expand)</summary>
|
|
750
|
+
|
|
751
|
+
**AI & LLM** — `claude` · `cohere` · `mistral-ai` · `minimax` · `together-ai` · `replicate` · `runwayml` · `elevenlabs` · `ollama` · `x-ai`
|
|
752
|
+
|
|
753
|
+
**Developer Tools** — `cursor` · `vercel` · `linear-app` · `framer` · `expo` · `clickhouse` · `mongodb` · `supabase` · `hashicorp` · `posthog` · `sentry` · `warp` · `webflow` · `sanity` · `mintlify` · `lovable` · `composio` · `opencode-ai` · `voltagent`
|
|
754
|
+
|
|
755
|
+
**Productivity** — `notion` · `figma` · `miro` · `airtable` · `superhuman` · `intercom` · `zapier` · `cal` · `clay` · `raycast`
|
|
756
|
+
|
|
757
|
+
**Fintech** — `stripe` · `coinbase` · `binance` · `kraken` · `mastercard` · `revolut` · `wise`
|
|
758
|
+
|
|
759
|
+
**E-Commerce** — `shopify` · `airbnb` · `uber` · `nike` · `starbucks` · `pinterest`
|
|
760
|
+
|
|
761
|
+
**Media** — `spotify` · `playstation` · `wired` · `theverge` · `meta`
|
|
762
|
+
|
|
763
|
+
**Automotive** — `tesla` · `bmw` · `ferrari` · `lamborghini` · `bugatti` · `renault`
|
|
764
|
+
|
|
765
|
+
**Other** — `apple` · `ibm` · `nvidia` · `vodafone` · `sentry` · `resend` · `spacex`
|
|
766
|
+
|
|
767
|
+
**Starters** — `default` (Neutral Modern) · `warm-editorial`
|
|
768
|
+
|
|
769
|
+
</details>
|
|
770
|
+
|
|
771
|
+
The product-system library is imported via [`scripts/sync-design-systems.ts`](scripts/sync-design-systems.ts) from [`VoltAgent/awesome-design-md`][acd2]. Re-run to refresh. The 57 design skills are sourced from [`bergside/awesome-design-skills`][ads] and added directly in `design-systems/`.
|
|
772
|
+
|
|
773
|
+
## Visual directions
|
|
774
|
+
|
|
775
|
+
When the user has no brand spec, the agent emits a second form with five curated directions — the OD adaptation of [`huashu-design`'s "5 schools × 20 design philosophies" fallback](https://github.com/alchaincyf/huashu-design#%E8%AE%BE%E8%AE%A1%E6%96%B9%E5%90%91%E9%A1%BE%E9%97%AE-fallback). Each direction is a deterministic spec — palette in OKLch, font stack, layout posture cues, references — that the agent binds verbatim into the seed template's `:root`. One radio click → a fully specified visual system. No improvisation, no AI-slop.
|
|
776
|
+
|
|
777
|
+
| Direction | Mood | Refs |
|
|
778
|
+
|---|---|---|
|
|
779
|
+
| Editorial — Monocle / FT | Print magazine, ink + cream + warm rust | Monocle · FT Weekend · NYT Magazine |
|
|
780
|
+
| Modern minimal — Linear / Vercel | Cool, structured, minimal accent | Linear · Vercel · Stripe |
|
|
781
|
+
| Tech utility | Information density, monospace, terminal | Bloomberg · Bauhaus tools |
|
|
782
|
+
| Brutalist | Raw, oversized type, no shadows, harsh accents | Bloomberg Businessweek · Achtung |
|
|
783
|
+
| Soft warm | Generous, low contrast, peachy neutrals | Notion marketing · Apple Health |
|
|
784
|
+
|
|
785
|
+
Full spec → [`apps/daemon/src/prompts/directions.ts`](apps/daemon/src/prompts/directions.ts).
|
|
786
|
+
|
|
787
|
+
## Media generation
|
|
788
|
+
|
|
789
|
+
OD doesn't stop at code. The same chat surface that produces `<artifact>` HTML also drives **image**, **video**, and **audio** generation, with model adapters wired into the daemon's media pipeline ([`apps/daemon/src/media-models.ts`](apps/daemon/src/media-models.ts), [`apps/web/src/media/models.ts`](apps/web/src/media/models.ts)). Every render lands as a real file in the project workspace — `.png` for image, `.mp4` for video — and shows up as a download chip when the turn ends.
|
|
790
|
+
|
|
791
|
+
Three model families carry the load today:
|
|
792
|
+
|
|
793
|
+
| Surface | Model | Provider | What it's for |
|
|
794
|
+
|---|---|---|---|
|
|
795
|
+
| **Image** | `gpt-image-2` | Azure / OpenAI | Posters, profile avatars, illustrated maps, infographics, magazine-style social cards, photo restoration, exploded-view product art |
|
|
796
|
+
| **Video** | `seedance-2.0` | ByteDance Volcengine | 15s cinematic t2v + i2v with audio — narrative shorts, character close-ups, product films, MV-style choreography |
|
|
797
|
+
| **Video** | `hyperframes-html` | [HeyGen / OSS](https://github.com/heygen-com/hyperframes) | HTML→MP4 motion graphics — product reveals, kinetic typography, data charts, social overlays, logo outros, TikTok-style verticals with karaoke captions |
|
|
798
|
+
|
|
799
|
+
A growing **prompt gallery** at [`prompt-templates/`](prompt-templates/) ships **93 ready-to-replicate prompts** — 43 image (`prompt-templates/image/*.json`), 39 Seedance (`prompt-templates/video/*.json` excluding `hyperframes-*`), 11 HyperFrames (`prompt-templates/video/hyperframes-*.json`). Each carries a preview thumbnail, the prompt body verbatim, the target model, the aspect ratio, and a `source` block for license + attribution. The daemon serves them at `GET /api/prompt-templates`, the web app surfaces them as a card grid in the **Image templates** and **Video templates** tabs of the entry view; one click drops a prompt into the composer with the right model preselected.
|
|
800
|
+
|
|
801
|
+
### gpt-image-2 — image gallery (sample of 43)
|
|
802
|
+
|
|
803
|
+
<table>
|
|
804
|
+
<tr>
|
|
805
|
+
<td width="20%" valign="top"><img src="https://cms-assets.youmind.com/media/1776661968404_8a5flm_HGQc_KOaMAA2vt0.jpg" alt="3D Stone Staircase Evolution" /><br/><sub><b>3D Stone Staircase Evolution Infographic</b><br/>3-step infographic, hewn-stone aesthetic</sub></td>
|
|
806
|
+
<td width="20%" valign="top"><img src="https://cms-assets.youmind.com/media/1776662673014_nf0taw_HGRMNDybsAAGG88.jpg" alt="Illustrated City Food Map" /><br/><sub><b>Illustrated City Food Map</b><br/>Editorial hand-illustrated travel poster</sub></td>
|
|
807
|
+
<td width="20%" valign="top"><img src="https://cms-assets.youmind.com/media/1777453149026_gd2k50_HHCSvymboAAVscc.jpg" alt="Cinematic Elevator Scene" /><br/><sub><b>Cinematic Elevator Scene</b><br/>Single-frame editorial fashion still</sub></td>
|
|
808
|
+
<td width="20%" valign="top"><img src="https://cms-assets.youmind.com/media/1777453164993_mt5b69_HHDoWfeaUAEA6Vt.jpg" alt="Cyberpunk Anime Portrait" /><br/><sub><b>Cyberpunk Anime Portrait</b><br/>Profile avatar — neon face text</sub></td>
|
|
809
|
+
<td width="20%" valign="top"><img src="https://cms-assets.youmind.com/media/1777453184257_vb9hvl_HG9tAkOa4AAuRrn.jpg" alt="Glamorous Woman in Black" /><br/><sub><b>Glamorous Woman in Black Portrait</b><br/>Editorial studio portrait</sub></td>
|
|
810
|
+
</tr>
|
|
811
|
+
</table>
|
|
812
|
+
|
|
813
|
+
Full set → [`prompt-templates/image/`](prompt-templates/image/). Sources: most pull from [`YouMind-OpenLab/awesome-gpt-image-prompts`](https://github.com/YouMind-OpenLab/awesome-gpt-image-prompts) (CC-BY-4.0) with author attribution preserved per template.
|
|
814
|
+
|
|
815
|
+
### Seedance 2.0 — video gallery (sample of 39)
|
|
816
|
+
|
|
817
|
+
<table>
|
|
818
|
+
<tr>
|
|
819
|
+
<td width="20%" valign="top"><a href="https://customer-qs6wnyfuv0gcybzj.cloudflarestream.com/c4515f4f328539e1ded2cc32f4ce63e7/downloads/default.mp4"><img src="https://customer-qs6wnyfuv0gcybzj.cloudflarestream.com/c4515f4f328539e1ded2cc32f4ce63e7/thumbnails/thumbnail.jpg" alt="Music Podcast Guitar" /></a><br/><sub><b>Music Podcast & Guitar Technique</b><br/>4K cinematic studio film</sub></td>
|
|
820
|
+
<td width="20%" valign="top"><a href="https://customer-qs6wnyfuv0gcybzj.cloudflarestream.com/4a47ba646e7cedd79363c861864b8714/downloads/default.mp4"><img src="https://customer-qs6wnyfuv0gcybzj.cloudflarestream.com/4a47ba646e7cedd79363c861864b8714/thumbnails/thumbnail.jpg" alt="Emotional Face" /></a><br/><sub><b>Emotional Face Close-up</b><br/>Cinematic micro-expression study</sub></td>
|
|
821
|
+
<td width="20%" valign="top"><a href="https://customer-qs6wnyfuv0gcybzj.cloudflarestream.com/7e8983364a95fe333f0f88bd1085a0e8/downloads/default.mp4"><img src="https://customer-qs6wnyfuv0gcybzj.cloudflarestream.com/7e8983364a95fe333f0f88bd1085a0e8/thumbnails/thumbnail.jpg" alt="Luxury Supercar" /></a><br/><sub><b>Luxury Supercar Cinematic</b><br/>Narrative product film</sub></td>
|
|
822
|
+
<td width="20%" valign="top"><a href="https://customer-qs6wnyfuv0gcybzj.cloudflarestream.com/0279a674ce138ab5a0a6f020a7273d89/downloads/default.mp4"><img src="https://customer-qs6wnyfuv0gcybzj.cloudflarestream.com/0279a674ce138ab5a0a6f020a7273d89/thumbnails/thumbnail.jpg" alt="Forbidden City Cat" /></a><br/><sub><b>Forbidden City Cat Satire</b><br/>Stylised satire short</sub></td>
|
|
823
|
+
<td width="20%" valign="top"><a href="https://github.com/YouMind-OpenLab/awesome-seedance-2-prompts/releases/download/videos/1402.mp4"><img src="https://customer-qs6wnyfuv0gcybzj.cloudflarestream.com/7f63ad253175a9ad1dac53de490efac8/thumbnails/thumbnail.jpg" alt="Japanese Romance" /></a><br/><sub><b>Japanese Romance Short Film</b><br/>15s Seedance 2.0 narrative</sub></td>
|
|
824
|
+
</tr>
|
|
825
|
+
</table>
|
|
826
|
+
|
|
827
|
+
Click any thumbnail to play the actual rendered MP4. Full set → [`prompt-templates/video/`](prompt-templates/video/) (the `*-seedance-*` and Cinematic-tagged entries). Sources: [`YouMind-OpenLab/awesome-seedance-2-prompts`](https://github.com/YouMind-OpenLab/awesome-seedance-2-prompts) (CC-BY-4.0) with original tweet links and author handles preserved.
|
|
828
|
+
|
|
829
|
+
### HyperFrames — HTML→MP4 motion graphics (11 ready-to-replicate templates)
|
|
830
|
+
|
|
831
|
+
[**`heygen-com/hyperframes`**](https://github.com/heygen-com/hyperframes) is HeyGen's open-source agent-native video framework — you (or the agent) write HTML + CSS + GSAP, HyperFrames renders it to a deterministic MP4 via headless Chrome + FFmpeg. Open Design ships HyperFrames as a first-class video model (`hyperframes-html`) wired into the daemon dispatch, plus the `skills/hyperframes/` skill that teaches the agent the timeline contract, scene-transition rules, audio-reactive patterns, captions/TTS, and the catalog blocks (`npx hyperframes add <slug>`).
|
|
832
|
+
|
|
833
|
+
Eleven hyperframes prompts ship under [`prompt-templates/video/hyperframes-*.json`](prompt-templates/video/), each one a concrete brief that produces a specific archetype:
|
|
834
|
+
|
|
835
|
+
<table>
|
|
836
|
+
<tr>
|
|
837
|
+
<td width="25%" valign="top"><a href="prompt-templates/video/hyperframes-product-reveal-minimal.json"><img src="https://static.heygen.ai/hyperframes-oss/docs/images/catalog/blocks/logo-outro.png" alt="Product reveal" /></a><br/><sub><b>5s minimal product reveal</b> · 16:9 · push-in title card with shader transition</sub></td>
|
|
838
|
+
<td width="25%" valign="top"><a href="prompt-templates/video/hyperframes-saas-product-promo-30s.json"><img src="https://static.heygen.ai/hyperframes-oss/docs/images/catalog/blocks/app-showcase.png" alt="SaaS promo" /></a><br/><sub><b>30s SaaS product promo</b> · 16:9 · Linear/ClickUp-style with UI 3D reveals</sub></td>
|
|
839
|
+
<td width="25%" valign="top"><a href="prompt-templates/video/hyperframes-tiktok-karaoke-talking-head.json"><img src="https://static.heygen.ai/hyperframes-oss/docs/images/catalog/blocks/tiktok-follow.png" alt="TikTok karaoke" /></a><br/><sub><b>TikTok karaoke talking-head</b> · 9:16 · TTS + word-synced captions</sub></td>
|
|
840
|
+
<td width="25%" valign="top"><a href="prompt-templates/video/hyperframes-brand-sizzle-reel.json"><img src="https://static.heygen.ai/hyperframes-oss/docs/images/catalog/blocks/logo-outro.png" alt="Brand sizzle" /></a><br/><sub><b>30s brand sizzle reel</b> · 16:9 · beat-synced kinetic typography, audio-reactive</sub></td>
|
|
841
|
+
</tr>
|
|
842
|
+
<tr>
|
|
843
|
+
<td width="25%" valign="top"><a href="prompt-templates/video/hyperframes-data-bar-chart-race.json"><img src="https://static.heygen.ai/hyperframes-oss/docs/images/catalog/blocks/data-chart.png" alt="Data chart" /></a><br/><sub><b>Animated bar-chart race</b> · 16:9 · NYT-style data infographic</sub></td>
|
|
844
|
+
<td width="25%" valign="top"><a href="prompt-templates/video/hyperframes-flight-map-route.json"><img src="https://static.heygen.ai/hyperframes-oss/docs/images/catalog/blocks/nyc-paris-flight.png" alt="Flight map" /></a><br/><sub><b>Flight map (origin → dest)</b> · 16:9 · Apple-style cinematic route reveal</sub></td>
|
|
845
|
+
<td width="25%" valign="top"><a href="prompt-templates/video/hyperframes-logo-outro-cinematic.json"><img src="https://static.heygen.ai/hyperframes-oss/docs/images/catalog/blocks/logo-outro.png" alt="Logo outro" /></a><br/><sub><b>4s cinematic logo outro</b> · 16:9 · piece-by-piece assembly + bloom</sub></td>
|
|
846
|
+
<td width="25%" valign="top"><a href="prompt-templates/video/hyperframes-money-counter-hype.json"><img src="https://static.heygen.ai/hyperframes-oss/docs/images/catalog/blocks/apple-money-count.png" alt="Money counter" /></a><br/><sub><b>$0 → $10K money counter</b> · 9:16 · Apple-style hype with green flash + burst</sub></td>
|
|
847
|
+
</tr>
|
|
848
|
+
<tr>
|
|
849
|
+
<td width="25%" valign="top"><a href="prompt-templates/video/hyperframes-app-showcase-three-phones.json"><img src="https://static.heygen.ai/hyperframes-oss/docs/images/catalog/blocks/app-showcase.png" alt="App showcase" /></a><br/><sub><b>3-phone app showcase</b> · 16:9 · floating phones with feature callouts</sub></td>
|
|
850
|
+
<td width="25%" valign="top"><a href="prompt-templates/video/hyperframes-social-overlay-stack.json"><img src="https://static.heygen.ai/hyperframes-oss/docs/images/catalog/blocks/instagram-follow.png" alt="Social overlay" /></a><br/><sub><b>Social overlay stack</b> · 9:16 · X · Reddit · Spotify · Instagram in sequence</sub></td>
|
|
851
|
+
<td width="25%" valign="top"><a href="prompt-templates/video/hyperframes-website-to-video-promo.json"><img src="https://static.heygen.ai/hyperframes-oss/docs/images/catalog/blocks/instagram-follow.png" alt="Website to video" /></a><br/><sub><b>Website-to-video pipeline</b> · 16:9 · captures site at 3 viewports + transitions</sub></td>
|
|
852
|
+
<td width="25%" valign="top"> </td>
|
|
853
|
+
</tr>
|
|
854
|
+
</table>
|
|
855
|
+
|
|
856
|
+
Pattern is the same as the rest: pick a template, edit the brief, send. The agent reads the bundled `skills/hyperframes/SKILL.md` (which carries the OD-specific render workflow — composition source files into a `.hyperframes-cache/` so they don't clutter the file workspace, daemon dispatches `npx hyperframes render` to dodge the macOS sandbox-exec / Puppeteer hang, only the final `.mp4` lands as a project chip), authors the composition, and ships an MP4. Catalog block thumbnails © HeyGen, served from their CDN; the OSS framework itself is Apache-2.0.
|
|
857
|
+
|
|
858
|
+
> **Also wired but not surfaced as templates yet:** Kling 2.0 / 1.6 / 1.5, Veo 3 / Veo 2, Sora 2 / Sora 2-Pro (via Fal), MiniMax video-01 — all live in `VIDEO_MODELS` ([`apps/web/src/media/models.ts`](apps/web/src/media/models.ts)). Suno v5 / v4.5, Udio v2, Lyria 2 (music) and gpt-4o-mini-tts, MiniMax TTS (speech) cover the audio surface. Templates for these are open contributions — drop a JSON into `prompt-templates/video/` or `prompt-templates/audio/` and it shows up in the picker.
|
|
859
|
+
|
|
860
|
+
## Beyond chat — what else ships
|
|
861
|
+
|
|
862
|
+
The chat / artifact loop gets the spotlight, but a handful of less-visible capabilities are already wired and worth knowing before you compare OD to anything else:
|
|
863
|
+
|
|
864
|
+
- **Claude Design ZIP import.** Drop an export from claude.ai onto the welcome dialog. `POST /api/import/claude-design` extracts it into a real `.od/projects/<id>/`, opens the entry file as a tab, and stages a continue-where-Anthropic-left-off prompt for your local agent. No re-prompting, no "ask the model to re-create what we just had". ([`apps/daemon/src/server.ts`](apps/daemon/src/server.ts) — `/api/import/claude-design`)
|
|
865
|
+
- **Multi-provider BYOK proxy.** `POST /api/proxy/{anthropic,openai,azure,google}/stream` takes `{ baseUrl, apiKey, model, messages }`, builds the provider-specific upstream request, normalizes SSE chunks into `delta/end/error`, and allows loopback local LLM providers while rejecting non-loopback private, link-local, CGNAT, multicast, reserved, and redirect targets to head off SSRF. OpenAI-compatible covers OpenAI, Azure AI Foundry `/openai/v1`, DeepSeek, Groq, MiMo, OpenRouter, Ollama, LM Studio, and self-hosted vLLM; Azure OpenAI adds deployment URL + `api-version`; Google uses Gemini `:streamGenerateContent`.
|
|
866
|
+
- **User-saved templates.** Once you like a render, `POST /api/templates` snapshots the HTML + metadata into the SQLite `templates` table. The next project picks it from a "your templates" row in the picker — same surface as the shipped 31, but yours.
|
|
867
|
+
- **Tab persistence.** Every project remembers its open files and active tab in the `tabs` table. Reopen the project tomorrow and the workspace looks exactly the way you left it.
|
|
868
|
+
- **Artifact lint API.** `POST /api/artifacts/lint` runs structural checks on a generated artifact (broken `<artifact>` framing, missing required side files, stale palette tokens) and returns findings the agent can read back into its next turn. The five-dim self-critique uses this to ground its score in real evidence, not vibes.
|
|
869
|
+
- **Sidecar protocol + desktop automation.** Daemon, web, and desktop processes carry typed five-field stamps (`app · mode · namespace · ipc · source`) and expose a JSON-RPC IPC channel at `/tmp/open-design/ipc/<namespace>/<app>.sock`. `tools-dev inspect desktop status \| eval \| screenshot` drives that channel, so headless E2E works against a real Electron shell without bespoke harnesses ([`packages/sidecar-proto/`](packages/sidecar-proto/), [`apps/desktop/src/main/`](apps/desktop/src/main/)).
|
|
870
|
+
- **Windows-friendly spawning.** Every adapter that would otherwise blow `CreateProcess`'s ~32 KB argv limit on long composed prompts (Codex, Gemini, OpenCode, Cursor Agent, Qwen, Qoder CLI, Pi) feeds the prompt over stdin instead. Claude Code and Copilot keep `-p`; the daemon falls back to a temp prompt-file when even that overflows.
|
|
871
|
+
- **Per-namespace runtime data.** `OD_DATA_DIR` and `--namespace` give you fully isolated `.od/`-style trees, so Playwright, beta channels, and your real projects never share a SQLite file.
|
|
872
|
+
|
|
873
|
+
## Anti-AI-slop machinery
|
|
874
|
+
|
|
875
|
+
The whole machinery below is the [`huashu-design`](https://github.com/alchaincyf/huashu-design) playbook, ported into OD's prompt-stack and made enforceable per-skill via the side-file pre-flight. Read [`apps/daemon/src/prompts/discovery.ts`](apps/daemon/src/prompts/discovery.ts) for the live wording:
|
|
876
|
+
|
|
877
|
+
- **Question form first.** Turn 1 is `<question-form>` only — no thinking, no tools, no narration. The user chooses defaults at radio speed.
|
|
878
|
+
- **Brand-spec extraction.** When the user attaches a screenshot or URL, the agent runs a five-step protocol (locate · download · grep hex · codify `brand-spec.md` · vocalise) before writing CSS. **Never guesses brand colors from memory.**
|
|
879
|
+
- **Five-dim critique.** Before emitting `<artifact>`, the agent silently scores its output 1–5 across philosophy / hierarchy / execution / specificity / restraint. Anything under 3/5 is a regression — fix and rescore. Two passes is normal.
|
|
880
|
+
- **P0/P1/P2 checklist.** Every skill ships a `references/checklist.md` with hard P0 gates. The agent must pass P0 before emitting.
|
|
881
|
+
- **Slop blacklist.** Aggressive purple gradients, generic emoji icons, rounded card with left-border accent, hand-drawn SVG humans, Inter as a *display* face, invented metrics — explicitly forbidden in the prompt.
|
|
882
|
+
- **Honest placeholders > fake stats.** When the agent doesn't have a real number, it writes `—` or a labelled grey block, not "10× faster".
|
|
883
|
+
|
|
884
|
+
## Comparison
|
|
885
|
+
|
|
886
|
+
| Axis | [Claude Design][cd] (Anthropic) | [Open CoDesign][ocod] | **Open Design** |
|
|
887
|
+
|---|---|---|---|
|
|
888
|
+
| License | Closed | MIT | **Apache-2.0** |
|
|
889
|
+
| Form factor | Web (claude.ai) | Desktop (Electron) | **Web app + local daemon** |
|
|
890
|
+
| Deployable on Vercel | ❌ | ❌ | **✅** |
|
|
891
|
+
| Agent runtime | Bundled (Opus 4.7) | Bundled ([`pi-ai`][piai]) | **Delegated to user's existing CLI** |
|
|
892
|
+
| Skills | Proprietary | 12 custom TS modules + `SKILL.md` | **31 file-based [`SKILL.md`][skill] bundles, droppable** |
|
|
893
|
+
| Design system | Proprietary | `DESIGN.md` (v0.2 roadmap) | **`DESIGN.md` × 129 systems shipped** |
|
|
894
|
+
| Provider flexibility | Anthropic only | 7+ via [`pi-ai`][piai] | **16 CLI adapters + OpenAI-compatible BYOK proxy** |
|
|
895
|
+
| Init question form | ❌ | ❌ | **✅ Hard rule, turn 1** |
|
|
896
|
+
| Direction picker | ❌ | ❌ | **✅ 5 deterministic directions** |
|
|
897
|
+
| Live todo progress + tool stream | ❌ | ✅ | **✅** (UX pattern from open-codesign) |
|
|
898
|
+
| Sandboxed iframe preview | ❌ | ✅ | **✅** (pattern from open-codesign) |
|
|
899
|
+
| Claude Design ZIP import | n/a | ❌ | **✅ `POST /api/import/claude-design` — keep editing where Anthropic left off** |
|
|
900
|
+
| Comment-mode surgical edits | ❌ | ✅ | 🟡 partial — preview element comments + chat attachments; surgical patch reliability still in progress |
|
|
901
|
+
| AI-emitted tweaks panel | ❌ | ✅ | 🚧 roadmap — dedicated chat-side panel UX is not implemented yet |
|
|
902
|
+
| Filesystem-grade workspace | ❌ | partial (Electron sandbox) | **✅ Real cwd, real tools, persisted SQLite (projects · conversations · messages · tabs · templates)** |
|
|
903
|
+
| 5-dim self-critique | ❌ | ❌ | **✅ Pre-emit gate** |
|
|
904
|
+
| Artifact lint | ❌ | ❌ | **✅ `POST /api/artifacts/lint` — findings fed back to the agent** |
|
|
905
|
+
| Sidecar IPC + headless desktop | ❌ | ❌ | **✅ Stamped processes + `tools-dev inspect desktop status \| eval \| screenshot`** |
|
|
906
|
+
| Export formats | Limited | HTML / PDF / PPTX / ZIP / Markdown | **HTML / PDF / PPTX (agent-driven) / ZIP / Markdown** |
|
|
907
|
+
| PPT skill reuse | N/A | Built-in | **[`guizang-ppt-skill`][guizang] drops in (default for deck mode)** |
|
|
908
|
+
| Minimum billing | Pro / Max / Team | BYOK | **BYOK — paste any OpenAI-compatible `baseUrl`** |
|
|
909
|
+
|
|
910
|
+
[cd]: https://x.com/claudeai/status/2045156267690213649
|
|
911
|
+
[ocod]: https://github.com/OpenCoworkAI/open-codesign
|
|
912
|
+
[piai]: https://github.com/badlogic/pi-mono/tree/main/packages/ai
|
|
913
|
+
[acd]: https://github.com/VoltAgent/awesome-claude-design
|
|
914
|
+
[guizang]: https://github.com/op7418/guizang-ppt-skill
|
|
915
|
+
[skill]: https://docs.anthropic.com/en/docs/claude-code/skills
|
|
916
|
+
|
|
917
|
+
## Supported coding agents
|
|
918
|
+
|
|
919
|
+
Auto-detected from `PATH` on daemon boot. No config required. Streaming dispatch lives in [`apps/daemon/src/agents.ts`](apps/daemon/src/agents.ts) (`AGENT_DEFS`); per-CLI parsers live alongside it. Models are populated either by probing `<bin> --list-models` / `<bin> models` / ACP handshake, or from a curated fallback list when the CLI doesn't expose a list.
|
|
920
|
+
|
|
921
|
+
| Agent | Bin | Stream format | Argv shape (composed prompt path) |
|
|
922
|
+
|---|---|---|---|
|
|
923
|
+
| [Claude Code](https://docs.anthropic.com/en/docs/claude-code) | `claude` | `claude-stream-json` (typed events) | `claude -p <prompt> --output-format stream-json --verbose [--include-partial-messages] [--add-dir …] --permission-mode bypassPermissions` |
|
|
924
|
+
| [Codex CLI](https://github.com/openai/codex) | `codex` | `json-event-stream` + `codex` parser | `codex exec --json --skip-git-repo-check --sandbox workspace-write -c sandbox_workspace_write.network_access=true [-C cwd] [--add-dir …] [--model …] [-c model_reasoning_effort=…]` (prompt on stdin) |
|
|
925
|
+
| Devin for Terminal | `devin` | `acp-json-rpc` | `devin --permission-mode dangerous --respect-workspace-trust false acp` |
|
|
926
|
+
| [Gemini CLI](https://github.com/google-gemini/gemini-cli) | `gemini` | `json-event-stream` + `gemini` parser | `GEMINI_CLI_TRUST_WORKSPACE=true gemini --output-format stream-json --yolo [--model …]` (prompt on stdin) |
|
|
927
|
+
| [OpenCode](https://opencode.ai/) | `opencode` | `json-event-stream` + `opencode` parser | `opencode run --format json --dangerously-skip-permissions [--model …] -` (prompt on stdin) |
|
|
928
|
+
| [Cursor Agent](https://www.cursor.com/cli) | `cursor-agent` | `json-event-stream` + `cursor-agent` parser | `cursor-agent --print --output-format stream-json --stream-partial-output --force --trust [--workspace cwd] [--model …] -` (prompt on stdin) |
|
|
929
|
+
| [Qwen Code](https://github.com/QwenLM/qwen-code) | `qwen` | `plain` (raw stdout chunks) | `qwen --yolo [--model …] -` (prompt on stdin) |
|
|
930
|
+
| Qoder CLI | `qodercli` | `qoder-stream-json` (typed events) | `qodercli -p --output-format stream-json --permission-mode bypass_permissions [--cwd cwd] [--model …] [--add-dir …]` (prompt on stdin) |
|
|
931
|
+
| [GitHub Copilot CLI](https://github.com/features/copilot/cli) | `copilot` | `copilot-stream-json` (typed events) | `copilot -p <prompt> --allow-all-tools --output-format json [--model …] [--add-dir …]` |
|
|
932
|
+
| [Hermes](https://github.com/eqlabs/hermes) | `hermes` | `acp-json-rpc` (Agent Client Protocol) | `hermes acp --accept-hooks` |
|
|
933
|
+
| Kimi CLI | `kimi` | `acp-json-rpc` | `kimi acp` |
|
|
934
|
+
| [Kiro CLI](https://kiro.dev) | `kiro-cli` | `acp-json-rpc` | `kiro-cli acp` |
|
|
935
|
+
| Kilo | `kilo` | `acp-json-rpc` | `kilo acp` |
|
|
936
|
+
| [Mistral Vibe CLI](https://github.com/mistralai/mistral-vibe) | `vibe-acp` | `acp-json-rpc` | `vibe-acp` |
|
|
937
|
+
| DeepSeek TUI | `deepseek` | `plain` (raw stdout chunks) | `deepseek exec --auto [--model …] <prompt>` (prompt as positional arg) |
|
|
938
|
+
| [Pi](https://github.com/badlogic/pi-mono/tree/main/packages/coding-agent) | `pi` | `pi-rpc` (stdio JSON-RPC) | `pi --mode rpc [--model …] [--thinking …]` (prompt sent as RPC `prompt` command) |
|
|
939
|
+
| **Multi-provider BYOK** | n/a | SSE normalization | `POST /api/proxy/{provider}/stream` → Anthropic / OpenAI-compatible / Azure OpenAI / Gemini; SSRF-guarded with loopback local providers allowed, non-loopback internal ranges blocked, and upstream redirects disabled |
|
|
940
|
+
|
|
941
|
+
Adding a new CLI is one entry in [`apps/daemon/src/agents.ts`](apps/daemon/src/agents.ts). Streaming format is one of `claude-stream-json`, `qoder-stream-json`, `copilot-stream-json`, `json-event-stream` (with a per-CLI `eventParser`), `acp-json-rpc`, `pi-rpc`, or `plain`.
|
|
942
|
+
|
|
943
|
+
## References & lineage
|
|
944
|
+
|
|
945
|
+
Every external project this repo borrows from. Each link goes to the source so you can verify the provenance.
|
|
946
|
+
|
|
947
|
+
| Project | Role here |
|
|
948
|
+
|---|---|
|
|
949
|
+
| [`Claude Design`][cd] | The closed-source product this repo is the open-source alternative to. |
|
|
950
|
+
| [**`alchaincyf/huashu-design`**](https://github.com/alchaincyf/huashu-design) | The design-philosophy core. Junior-Designer workflow, the 5-step brand-asset protocol, anti-AI-slop checklist, 5-dimensional self-critique, and the "5 schools × 20 design philosophies" library behind our direction picker — all distilled into [`apps/daemon/src/prompts/discovery.ts`](apps/daemon/src/prompts/discovery.ts) and [`apps/daemon/src/prompts/directions.ts`](apps/daemon/src/prompts/directions.ts). |
|
|
951
|
+
| [**`op7418/guizang-ppt-skill`**][guizang] | Magazine-web-PPT skill bundled verbatim under [`skills/guizang-ppt/`](skills/guizang-ppt/) with original LICENSE preserved. Default for deck mode. P0/P1/P2 checklist culture borrowed for every other skill. |
|
|
952
|
+
| [**`multica-ai/multica`**](https://github.com/multica-ai/multica) | The daemon + adapter architecture. PATH-scan agent detection, local daemon as the only privileged process, agent-as-teammate worldview. We adopt the model; we do not vendor the code. |
|
|
953
|
+
| [**`OpenCoworkAI/open-codesign`**][ocod] | The first open-source Claude-Design alternative and our closest peer. UX patterns adopted: streaming-artifact loop, sandboxed-iframe preview (vendored React 18 + Babel), live agent panel (todos + tool calls + interruptible), five-format export list (HTML/PDF/PPTX/ZIP/Markdown), local-first storage hub, `SKILL.md` taste-injection, and the first pass of comment-mode preview annotations. UX patterns still on our roadmap: full surgical-edit reliability and AI-emitted tweaks panel. **We deliberately do not vendor [`pi-ai`][piai]** — open-codesign bundles it as the agent runtime; we delegate to whichever CLI the user already has. |
|
|
954
|
+
| [`VoltAgent/awesome-claude-design`][acd] / [`awesome-design-md`][acd2] | Source of the 9-section `DESIGN.md` schema and 70 product systems imported via [`scripts/sync-design-systems.ts`](scripts/sync-design-systems.ts). |
|
|
955
|
+
| [`bergside/awesome-design-skills`][ads] | Source of 57 design skills added directly as normalized `DESIGN.md` files under `design-systems/`. |
|
|
956
|
+
| [`farion1231/cc-switch`](https://github.com/farion1231/cc-switch) | Inspiration for symlink-based skill distribution across multiple agent CLIs. |
|
|
957
|
+
| [Claude Code skills][skill] | The `SKILL.md` convention adopted verbatim — any Claude Code skill drops into `skills/` and is picked up by the daemon. |
|
|
958
|
+
|
|
959
|
+
Long-form provenance write-up — what we take from each, what we deliberately don't — lives at [`docs/references.md`](docs/references.md).
|
|
960
|
+
|
|
961
|
+
## Roadmap
|
|
962
|
+
|
|
963
|
+
- [x] Daemon + agent detection (16 CLI adapters) + skill registry + design-system catalog
|
|
964
|
+
- [x] Web app + chat + question form + 5-direction picker + todo progress + sandboxed preview
|
|
965
|
+
- [x] 31 skills + 72 design systems + 5 visual directions + 5 device frames
|
|
966
|
+
- [x] SQLite-backed projects · conversations · messages · tabs · templates
|
|
967
|
+
- [x] Multi-provider BYOK proxy (`/api/proxy/{anthropic,openai,azure,google}/stream`) with SSRF guard
|
|
968
|
+
- [x] Claude Design ZIP import (`/api/import/claude-design`)
|
|
969
|
+
- [x] Sidecar protocol + Electron desktop with IPC automation (STATUS / EVAL / SCREENSHOT / CONSOLE / CLICK / SHUTDOWN)
|
|
970
|
+
- [x] Artifact lint API + 5-dim self-critique pre-emit gate
|
|
971
|
+
- [ ] Comment-mode surgical edits — partial shipped: preview element comments and chat attachments; reliable targeted patching remains in progress
|
|
972
|
+
- [ ] AI-emitted tweaks panel UX — not implemented yet
|
|
973
|
+
- [ ] Vercel + tunnel deployment recipe (Topology B)
|
|
974
|
+
- [ ] One-command `npx od init` to scaffold a project with `DESIGN.md`
|
|
975
|
+
- [ ] Skill marketplace (`od skills install <github-repo>`) and `od skill add | list | remove | test` CLI surface (drafted in [`docs/skills-protocol.md`](docs/skills-protocol.md), implementation pending)
|
|
976
|
+
- [x] Packaged Electron build out of `apps/packaged/` — macOS (Apple Silicon) and Windows (x64) downloads on [open-design.ai](https://open-design.ai/) and the [GitHub releases page](https://github.com/nexu-io/open-design/releases)
|
|
977
|
+
|
|
978
|
+
Phased delivery → [`docs/roadmap.md`](docs/roadmap.md).
|
|
979
|
+
|
|
980
|
+
## Status
|
|
981
|
+
|
|
982
|
+
This is an early implementation — the closed loop (detect → pick skill + design system → chat → parse `<artifact>` → preview → save) runs end-to-end. The prompt stack and skill library are where most of the value lives, and they're stable. The component-level UI is shipping daily.
|
|
983
|
+
|
|
984
|
+
## Stay in the loop
|
|
985
|
+
|
|
986
|
+
Follow **[@nexudotio](https://x.com/nexudotio)** on X for release notes, new skills, new design systems, and the occasional behind-the-scenes thread on what's shipping next. Discord is for chat, X is for the milestones — both links are in the badges above.
|
|
987
|
+
|
|
988
|
+
## Star us
|
|
989
|
+
|
|
990
|
+
<p align="center">
|
|
991
|
+
<a href="https://github.com/nexu-io/open-design"><img src="docs/assets/star-us.png" alt="Star Open Design on GitHub — github.com/nexu-io/open-design" width="100%" /></a>
|
|
992
|
+
</p>
|
|
993
|
+
|
|
994
|
+
If this saved you thirty minutes — give it a ★. Stars don't pay rent, but they tell the next designer, agent, and contributor that this experiment is worth their attention. One click, three seconds, real signal: [github.com/nexu-io/open-design](https://github.com/nexu-io/open-design).
|
|
995
|
+
|
|
996
|
+
## Contributing
|
|
997
|
+
|
|
998
|
+
Issues, PRs, new skills, and new design systems are all welcome. The highest-leverage contributions are usually one folder, one Markdown file, or one PR-sized adapter:
|
|
999
|
+
|
|
1000
|
+
- **Add a skill** — drop a folder into [`skills/`](skills/) following the [`SKILL.md`][skill] convention.
|
|
1001
|
+
- **Add a design system** — drop a `DESIGN.md` into [`design-systems/<brand>/`](design-systems/) using the 9-section schema.
|
|
1002
|
+
- **Wire up a new coding-agent CLI** — one entry in [`apps/daemon/src/agents.ts`](apps/daemon/src/agents.ts).
|
|
1003
|
+
|
|
1004
|
+
Full walkthrough, bar-for-merging, code style, and what we don't accept → [`CONTRIBUTING.md`](CONTRIBUTING.md) ([Deutsch](CONTRIBUTING.de.md), [Français](CONTRIBUTING.fr.md), [简体中文](CONTRIBUTING.zh-CN.md)).
|
|
1005
|
+
|
|
1006
|
+
## Contributors
|
|
1007
|
+
|
|
1008
|
+
Thanks to everyone who has helped move Open Design forward — through code, docs, feedback, new skills, new design systems, or even a sharp issue. Every real contribution counts, and the wall below is the easiest way to say so out loud.
|
|
1009
|
+
|
|
1010
|
+
<a href="https://github.com/nexu-io/open-design/graphs/contributors">
|
|
1011
|
+
<img src="https://contrib.rocks/image?repo=nexu-io/open-design&cache_bust=2026-05-15" alt="Open Design contributors" />
|
|
1012
|
+
</a>
|
|
1013
|
+
|
|
1014
|
+
If you've shipped your first PR — welcome. The [`good-first-issue`/`help-wanted`](https://github.com/nexu-io/open-design/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22%2C%22help+wanted%22) label is the entry point.
|
|
1015
|
+
|
|
1016
|
+
## Repository activity
|
|
1017
|
+
|
|
1018
|
+
<picture>
|
|
1019
|
+
<img alt="Open Design — repository metrics" src="docs/assets/github-metrics.svg" />
|
|
1020
|
+
</picture>
|
|
1021
|
+
|
|
1022
|
+
The SVG above is regenerated daily by [`.github/workflows/metrics.yml`](.github/workflows/metrics.yml) using [`lowlighter/metrics`](https://github.com/lowlighter/metrics). Trigger a manual refresh from the **Actions** tab if you want it sooner; for richer plugins (traffic, follow-up time), add a `METRICS_TOKEN` repository secret with a fine-grained PAT.
|
|
1023
|
+
|
|
1024
|
+
## Star History
|
|
1025
|
+
|
|
1026
|
+
<a href="https://star-history.com/#nexu-io/open-design&Date">
|
|
1027
|
+
<picture>
|
|
1028
|
+
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=nexu-io/open-design&type=Date&theme=dark&cache_bust=2026-05-15" />
|
|
1029
|
+
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=nexu-io/open-design&type=Date&cache_bust=2026-05-15" />
|
|
1030
|
+
<img alt="Open Design star history" src="https://api.star-history.com/svg?repos=nexu-io/open-design&type=Date&cache_bust=2026-05-15" />
|
|
1031
|
+
</picture>
|
|
1032
|
+
</a>
|
|
1033
|
+
|
|
1034
|
+
If the curve bends up, that's the signal we look for. ★ this repo to push it.
|
|
1035
|
+
|
|
1036
|
+
## Credits
|
|
1037
|
+
|
|
1038
|
+
The HTML PPT Studio family of skills — the master [`skills/html-ppt/`](skills/html-ppt/) and the per-template wrappers under [`skills/html-ppt-*/`](skills/) (15 full-deck templates, 36 themes, 31 single-page layouts, 27 CSS animations + 20 canvas FX, the keyboard runtime, and the magnetic-card presenter mode) — are integrated from the open-source project [`lewislulu/html-ppt-skill`](https://github.com/lewislulu/html-ppt-skill) (MIT). The upstream LICENSE ships in-tree at [`skills/html-ppt/LICENSE`](skills/html-ppt/LICENSE) and authorship credit goes to [@lewislulu](https://github.com/lewislulu). Each per-template Examples card (`html-ppt-pitch-deck`, `html-ppt-tech-sharing`, `html-ppt-presenter-mode`, `html-ppt-xhs-post`, …) delegates authoring guidance to the master skill so the upstream's prompt → output behavior is preserved end-to-end when you click **Use this prompt**.
|
|
1039
|
+
|
|
1040
|
+
The magazine / horizontal-swipe deck flow under [`skills/guizang-ppt/`](skills/guizang-ppt/) is integrated from [`op7418/guizang-ppt-skill`](https://github.com/op7418/guizang-ppt-skill) (MIT). Authorship credit goes to [@op7418](https://github.com/op7418).
|
|
1041
|
+
|
|
1042
|
+
## License
|
|
1043
|
+
|
|
1044
|
+
Apache-2.0. The bundled `skills/guizang-ppt/` retains its original [LICENSE](skills/guizang-ppt/LICENSE) (MIT) and authorship attribution to [op7418](https://github.com/op7418). The bundled `skills/html-ppt/` retains its original [LICENSE](skills/html-ppt/LICENSE) (MIT) and authorship attribution to [lewislulu](https://github.com/lewislulu).
|