Open CoDesign

English

中文

English

中文

Appearance

Quickstart ​

Get Open CoDesign running on macOS, Windows, or Linux in three steps.

1. Install ​

sh
# macOS
brew install --cask opencoworkai/tap/open-codesign

# Windows — Scoop
scoop bucket add opencoworkai https://github.com/OpenCoworkAI/scoop-bucket
scoop install open-codesign

# Windows — winget  (pending microsoft/winget-pkgs#363055)
winget install OpenCoworkAI.OpenCoDesign

Or direct download ​

Pick the matching installer from GitHub Releases:

PlatformFile
macOS (Apple Silicon)open-codesign-*-arm64.dmg
macOS (Intel)open-codesign-*-x64.dmg
Windows (x64)open-codesign-*-x64-setup.exe
Windows (ARM64)open-codesign-*-arm64-setup.exe
Linux (AppImage)open-codesign-*-x64.AppImage
Linux (Debian/Ubuntu)open-codesign-*-x64.deb
Linux (Fedora/RHEL)open-codesign-*-x64.rpm

v0.1 note

v0.1 installers are unsigned. macOS Sequoia 15+: right-click → Open no longer bypasses Gatekeeper; run xattr -cr "/Applications/Open CoDesign.app" once after installing (0.1.2 and earlier used /Applications/open-codesign.app). Windows: SmartScreen → More info → Run anyway. Prefer a verified build? Compile from source — see Architecture.

2. Add a provider ​

First launch opens the Settings page. Pick one path:

  • Import from Claude Code or Codex — one click, we read your existing config (~/.codex/config.toml, ~/.claude/settings.json) and bring every provider, model, and key over.
  • Manual — paste any API key. Provider is auto-detected from prefix (sk-ant-… → Anthropic, sk-… → OpenAI, etc.).
  • Keyless — for IP-allowlisted proxies (enterprise gateways, local Ollama), leave the key blank.

Supported out of the box: Anthropic Claude, OpenAI GPT, Google Gemini, DeepSeek, OpenRouter, SiliconFlow, local Ollama, and any OpenAI-compatible endpoint. Credentials stay in ~/.config/open-codesign/config.toml, encrypted via Electron safeStorage. Nothing is uploaded.

3. Type your first prompt ​

Pick one of eight built-in demos from the Hub, or type your own. The first artifact renders in seconds inside a sandboxed iframe — HTML or a live React component, depending on what the prompt calls for.

What to try next ​

  • Inline comment — click any element in the preview, leave a note. The model rewrites only that region.
  • Tunable sliders — the model exposes the parameters worth tuning (color, spacing, font). Drag to refine without round-tripping.
  • Switch designs — the last five designs keep their preview iframes alive for zero-delay switching.
  • Export — HTML, PDF (via your local Chrome), PPTX, ZIP, or Markdown, all generated on-device.

Build from source ​

bash
git clone https://github.com/OpenCoworkAI/open-codesign.git
cd open-codesign
pnpm install
pnpm dev

Requires Node 22 LTS and pnpm 9.15+. See Architecture for the repo layout.

Going further ​