Quickstart
Tiga perintah. Tanpa daftar.
Open Design punya satu titik masuk: pnpm tools-dev. Daemon otomatis bikin folder tersembunyi .od/ untuk DB SQLite proyek dan artifact per proyek. Tidak ada langkah od init.
Persyaratan
- · Node ~24 —
nvm install 24 && nvm use 24ataufnm install 24 && fnm use 24 - · pnpm 10.33.x —
corepack enable && corepack pnpm --version - · Setidaknya satu coding-agent CLI yang didukung di
PATHAnda — Claude Code, Codex, Cursor, Gemini, OpenCode, Qwen, Copilot, Devin, Hermes, Kimi, Kiro, Vibe, atau Pi (atau tidak ada, kalau Anda akan pakai proxy BYOK)
Tiga perintah
git clone https://github.com/nexu-io/open-design.git
cd open-design
corepack enable
pnpm install
pnpm tools-dev run webBuka URL web yang dicetak tools-dev. Munculkan dialog welcome, tempel key Anthropic (cuma perlu untuk fallback BYOK), ketik prompt, tekan Send.
Keadaan saat pertama jalan
Daemon memiliki satu folder tersembunyi.
.od/
├── app.sqlite ← projects · conversations · messages · tabs terbuka
├── artifacts/ ← render "Save to disk" sekali jadi (bertimestamp)
└── projects/<id>/ ← direktori kerja per proyek, juga cwd agent| Mau… | Lakukan ini |
|---|---|
| Intip apa di dalam | ls -la .od && sqlite3 .od/app.sqlite '.tables' |
| Reset ke kosong | pnpm tools-dev stop && rm -rf .od && pnpm tools-dev run web |
| Pindah ke tempat lain | Belum didukung — path-nya hardcoded relatif ke repo |
Perintah siklus hidup
Semuanya di bawah pnpm tools-dev.
pnpm tools-dev start # nyalakan daemon + web (background)
pnpm tools-dev run web # ekuivalen di foreground
pnpm tools-dev stop # hentikan semua
pnpm tools-dev status # apa yang jalan, di mana
pnpm tools-dev logs # tail log daemon + web
pnpm tools-dev inspect # IPC ke proses yang hidup
pnpm tools-dev check # health checkUntuk start desktop / background, restart di port tetap, dan detail dispatcher generasi media (OD_BIN, OD_DAEMON_URL), lihat QUICKSTART.md di GitHub.
Platform · v0.5.0
Tiga platform, tiga status.
0.5.0 jujur soal posisi tiap platform sekarang. Pilih baris yang cocok dengan mesin Anda.
| Platform | Status | Catatan |
|---|---|---|
| macOS | Stabil | Hanya Apple Silicon (arm64) — tidak ada build Intel. macOS 11 Big Sur atau lebih baru. |
| Windows | Stabil · belum ditandatangani | x64, Windows 10 / 11. SmartScreen memperingatkan saat pertama jalan — pilih More info → Run anyway. |
| Linux | Hanya headless | Lifecycle CLI kelas satu (install / start / stop) mendarat di 0.5.0. Belum ada paket GUI — pas untuk server dan CI. Lihat di bawah. |
Linux · headless
Jalankan Open Design di server tanpa DISPLAY.
v0.5.0 mengirim path lifecycle non-grafis. Naikkan daemon dan web di mesin Linux headless, lalu pukul dari browser laptop. Backend yang sama, tanpa shell Electron di depan.
pnpm install
pnpm tools-pack linux install --headless # setup sekali
pnpm tools-pack linux start --headless # daemon + web, tanpa Electron
pnpm tools-pack linux stop --headless
pnpm tools-pack linux logs # tail log headlessPaket apt, izin namespace, dan catatan FUSE didokumentasikan di tools/pack/README.md. Diverifikasi di Ubuntu 24.04 dan Arch Linux. Mendarat di 0.5.0 lewat PR #686.
Self-host · v0.5.0
Atau jalankan sebagai satu kontainer.
v0.5.0 mengirim path Docker Compose resmi. Satu image Alpine (docker.io/vanjayak/open-design). Daemon menyajikan API sekaligus static export Next.js yang sudah dibuild — tidak perlu nginx terpisah, tidak perlu kontainer frontend terpisah.
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:7456Default: bind ke 127.0.0.1:7456, batas memori 384 MB, runtime volume di /app/.od. Jangan publish daemon ke interface publik apa adanya — API tidak terotentikasi untuk klien non-browser. Pasang reverse proxy yang terotentikasi, tunnel SSH, atau VPN di depannya. Dokumen lengkap: deploy/README.md. Image sengaja tidak menyertakan CLI Claude / Codex / Gemini — simpan di luar kontainer.
Sekarang apa?
Pilih sesuatu untuk dirender.
Setelah daemon naik, Anda butuh skill (mau ngapain), design system (harus tampak seperti apa), dan idealnya referensi tentang seperti apa "bagus" itu.