Skip to main content

How to use open-design

Open Design injects into dsh's profile, using JSONL stdio driver to forward text, thoughts, tools, and usage via dsh, with resumption support.

This article is auto-derived from indexed fields (wiki / faq / compatibility_json), not freshly AI-generated.

This article is derived from the plugin's already-indexed fields (wiki / faq / compatibility_json / readme), not freshly generated by AI. Source field is noted at the end of each section.

Quick start

open-design

— source: plugin_wiki.wiki_content

Install & verify

dsh plugin --profile web add github:nexu-io/open-design#path:packages/dsh-runtime

Run the command above in your DSH Web Profile. Then enable the plugin in the plugin list.

— source: plugins.install

Key points

  • 🤖 Agent-native, model-agnostic. We don't ship an agent. The claude / codex / cursor-agent / copilot / hermes / kimi already on your PATH are the design engine. Swap with one click.
  • 🔒 Privacy by conviction. Everything runs where your data lives — your laptop, your team's server, your Vercel project. When the network is needed, the BYOK proxy is SSRF-guarded.
  • Linux (AppImage, optional lane) → GitHub Releases
  • 🔁 Migrate Figma / Pencil workflows → React, Next.js, or Vue source. See od-figma-migration.
  • 🛠️ Refresh an existing codebase to a brand spec — point a plugin at a git repo + DESIGN.md, get a PR. See od-code-migration.

— source: plugin_wiki.readme_en (fallback readme_raw)

FAQ

Do I need to install DeepSeek Harness first?

Yes. The plugin does not download or install dsh itself. Users need to first use the bootstrap installation script provided by Open Design (macOS/Linux: curl … install-dsh.sh; Windows: irm install-dsh.ps1) to install the official dsh and configure the model API Key in Harness's Web UI.

Will my API Key be saved in Open Design?

No. Open Design only stores credentials in dsh's Web UI in write-only mode. Open Design does not read or write back the Key in plaintext; at runtime, it lets dsh read its own configured key as needed.

Does each design task start a new dsh process?

Yes. Open Design initiates a short-lived dsh --profile open-design --stdio process for each run; Harness's session storage handles cross-process cold resume, so no session ID needs to be passed in CLI arguments.

What if I want to stop midway?

The protocol layer supports mid-course cancellation. After the host issues a cancel command, it will abort immediately; the plugin also preserves request-level intent during the AbortController uninitialized window and replays it when execute activates.

Can one process run multiple tasks simultaneously?

No. Each profile process accepts exactly one execute command; the second one will be rejected with DSH_PROFILE_BUSY; to use concurrency, the host side needs to spawn multiple processes.

How do I uninstall this connection component?

Simply use od agent setup deepseek-harness or DSH's built-in dsh plugin --profile open-design remove to uninstall. DSH's own installation, credentials, and model configurations will not be affected.

Will generated files stay in the Open Design project?

Yes. Harness places the files in OD's current project working directory; file monitoring and real-time preview are handled by Open Design's existing artifact pipeline.

What happens if the protocol handshake fails?

The detection phase only prints a JSON object failure message; Open Design still keeps DeepSeek Harness in the "Installed CLI" list and displays "Connection component needs to be installed". Users need to confirm again to reinstall via this plugin's dsh.

— source: plugin_wiki.faq_json

Compatibility

  • DSH: 0.1.0-rc.6+
  • Node: >=24
  • Platforms: macOS, Windows, Linux

— source: plugin_wiki.compatibility_json

Pitfalls

Review the upstream repo before installing. This guide is auto-derived from indexed fields and may lag the latest release. If anything contradicts the official docs, treat the upstream source as authoritative.

— source: general rule