快速上手
三条命令。 不用注册。
Open Design 只有一个入口:pnpm tools-dev。daemon 自动建一个隐藏的 .od/ 目录,放 SQLite 项目库和各项目的 artifact。没有 od init 步骤。
前置
- · Node ~24 ——
nvm install 24 && nvm use 24或fnm install 24 && fnm use 24 - · pnpm 10.33.x ——
corepack enable && corepack pnpm --version - ·
PATH上至少装一款支持的 coding-agent CLI —— Claude Code、Codex、Cursor、Gemini、OpenCode、Qwen、Copilot、Devin、Hermes、Kimi、Kiro、Vibe 或 Pi(也可以一个都不装,走 BYOK 代理)
三条命令
git clone https://github.com/nexu-io/open-design.git
cd open-design
corepack enable
pnpm install
pnpm tools-dev run web打开 tools-dev 打印的 Web URL。掀开欢迎弹窗,粘一个 Anthropic Key(只在走 BYOK 兜底时才需要),打一段 prompt,按发送。
首次运行的状态
daemon 只管一个隐藏目录。
.od/
├── app.sqlite ← 项目 · 对话 · 消息 · 打开的 tab
├── artifacts/ ← 一次性「保存到磁盘」的渲染(带时间戳)
└── projects/<id>/ ← 各项目的工作目录,也是 Agent 的 cwd| 想干嘛… | 这么干 |
|---|---|
| 看一下里面有什么 | ls -la .od && sqlite3 .od/app.sqlite '.tables' |
| 重置成干净的 | pnpm tools-dev stop && rm -rf .od && pnpm tools-dev run web |
| 挪到别的位置 | 暂不支持 —— 路径写死在仓库相对位置 |
生命周期命令
全部归在 pnpm tools-dev.
pnpm tools-dev start # 启动 daemon + web(后台)
pnpm tools-dev run web # 前台等价命令
pnpm tools-dev stop # 全停
pnpm tools-dev status # 看哪个在跑、跑在哪
pnpm tools-dev logs # 跟随 daemon + web 日志
pnpm tools-dev inspect # 通过 IPC 查看运行中的进程
pnpm tools-dev check # 健康检查桌面 / 后台启动、固定端口重启、媒体生成分发(OD_BIN、OD_DAEMON_URL)的细节,看 GitHub 上的 QUICKSTART.md。
平台 · v0.5.0
三个平台, 三种状态。
v0.5.0 直白地告诉你每个平台到了哪一步。挑你机器对应那一行。
| 平台 | 状态 | 备注 |
|---|---|---|
| macOS | 稳定 | 仅 Apple Silicon(arm64),没有 Intel build。macOS 11 Big Sur 及以上。 |
| Windows | 稳定 · 未签名 | x64,Windows 10 / 11。SmartScreen 首次启动会警告 —— 选 More info → Run anyway 跑过去。 |
| Linux | 仅 headless | v0.5.0 起 CLI 生命周期(install / start / stop)成头等支持。GUI 包还没出 —— 适合服务器和 CI。详见下文。 |
Linux · headless
在没有 DISPLAY 的服务器上跑 Open Design。
v0.5.0 加了一条不带图形的生命周期路径。在 headless Linux 机器上把 daemon 和 web 起起来,然后从你笔记本浏览器去打它。后端一模一样,前面没有 Electron 壳。
pnpm install
pnpm tools-pack linux install --headless # 一次性配好
pnpm tools-pack linux start --headless # daemon + web,无 Electron
pnpm tools-pack linux stop --headless
pnpm tools-pack linux logs # 跟随 headless 日志Apt 包、namespace 权限、FUSE 注意事项都在 tools/pack/README.md。Ubuntu 24.04 和 Arch Linux 上验过。0.5.0 PR #686 落地。
自部署 · v0.5.0
或者把它跑成 一个容器。
v0.5.0 给了正式的 Docker Compose 部署路径。一个 Alpine 镜像(docker.io/vanjayak/open-design)。daemon 同时管 API 和构建好的 Next.js 静态导出 —— 不用单独的 nginx,不用单独的前端容器。
git clone https://github.com/nexu-io/open-design.git
cd open-design/deploy
OPEN_DESIGN_IMAGE=docker.io/vanjayak/open-design:latest docker compose pull
OPEN_DESIGN_IMAGE=docker.io/vanjayak/open-design:latest docker compose up -d --no-build
# → http://127.0.0.1:7456默认绑 127.0.0.1:7456,内存上限 384 MB,运行时卷挂在 /app/.od。不要直接把 daemon 暴露到公网 —— 对非浏览器客户端,API 没认证。前面套一层有认证的反向代理、SSH 隧道或 VPN。完整文档:deploy/README.md。镜像设计上不打包 Claude / Codex / Gemini CLI —— 这些放到容器外面。
然后呢?
挑点东西渲染出来。
daemon 起来后,你需要一个 Skill(做什么)、一套 设计系统(怎么看),最好再有一个「好长什么样」的参考。