# Install Codex Design for Codex

Codex Design is an independent plugin that adds a local visual canvas for images and HTML designs to Codex. This document is intended for the agent the user has asked to install the plugin.

Canonical guide: https://codexdesign.io/install.md

## Public distribution

The public Git marketplace is https://github.com/ummydev/codexdesign, branch `main`. No GitHub account or private repository access is required. The plugin identifier is `codexdesign@codexdesign-github`.

## Prerequisites

- A Codex environment with plugin support and the Codex CLI available.
- Git and network access to GitHub.
- Node.js >=22.12.0 available in the MCP process PATH.
- The default published MCP launcher targets macOS/Linux. On native Windows, a PowerShell launcher and `.mcp.windows.json` are included, but Windows has not been verified end to end. Report this limitation before making platform-specific changes.

Check `codex plugin --help`, `git --version`, and `node --version`. If `codex` is not in PATH but the desktop app is installed, locate the CLI bundled with that app and use its absolute executable path in place of `codex` below (for example, the ChatGPT macOS app may bundle it at `/Applications/ChatGPT.app/Contents/Resources/codex-cli/CodexCLI.app/Contents/MacOS/codex`). Verify that executable supports `plugin` before proceeding. If a prerequisite is missing, explain exactly what is missing. Do not silently install a different runtime or bypass installation errors.

## Install from the remote Git marketplace

Use this exact repository, branch, marketplace name, and plugin identifier:

```sh
codex plugin marketplace add ummydev/codexdesign --ref main
codex plugin add codexdesign@codexdesign-github
codex plugin list
```

If the marketplace already exists, inspect `codex plugin marketplace list`. If it points at `https://github.com/ummydev/codexdesign.git` on main, refresh it:

```sh
codex plugin marketplace upgrade codexdesign-github
codex plugin add codexdesign@codexdesign-github
codex plugin list
```

If an earlier installation registered `codexdesign-github` from `ummydev/codexcanvas`, stop its running daemon as described below, then replace only that marketplace registration and reinstall:

```sh
codex plugin marketplace remove codexdesign-github
codex plugin marketplace add ummydev/codexdesign --ref main
codex plugin add codexdesign@codexdesign-github
codex plugin list
```

Do not remove unrelated marketplaces, projects, or settings. If that marketplace name points at an unrelated source, report the conflict instead of overwriting it.

Verify that `codexdesign@codexdesign-github` is installed and enabled. Use `codex plugin list --json` when available to verify `installed: true` and `enabled: true`, and report the installed version. Do not claim installation succeeded if any required step failed.

The public repository is `ummydev/codexdesign`; the plugin name is `codexdesign`. The marketplace points to the prebuilt `plugins/codexdesign/` directory on main.

## Installation boundaries

- Use the remote Git marketplace, never an existing local development checkout or the personal marketplace.
- The release includes the bundled MCP server, daemon, CLI, frontend, and skills.
- Do not run `npm install`, `npm ci`, or build commands in the user's workspace, plugin cache, or marketplace snapshot.
- Do not manually install React Flow or other plugin dependencies.
- Do not clone the repository into the personal marketplace.
- If installation fails, report the command and its error. Do not build from source as a workaround.
- Preserve existing canvas projects and user settings.

## After installation

Ask the user to completely quit and restart Codex, then start a new conversation. Do not assume the current conversation can already access the newly installed tools. Suggest this first prompt:

> Use Codex Design to explore three directions for a login page and open the canvas.

Only create a separate task if the user explicitly asked for it and the host offers that capability. Otherwise provide the suggested first prompt.

## Updating an existing installation

The canvas daemon runs independently of Codex. If an old Codex Design daemon is running, locate the installed plugin and run `node scripts/start.cjs stop` from its directory before upgrading. Then refresh the marketplace and reinstall using the commands above. Restart Codex and open a new conversation.

## Cost and data

Codex Design requires no separate API key or plugin token wallet. Codex access, plan limits, and applicable usage charges still apply; this is not a promise of unlimited free model usage.

Canvas project files are stored locally, by default under `~/.codex-design-plugin/projects`. This does not change Codex's handling of conversation context or submitted files. Updating the plugin does not require deleting project data.