Get started

Installing text-to-cad

One command installs text-to-cad and its plugin in every agent app on your computer:

curl -fsSL https://texttocad.dev/install.sh | sh

On Windows, in PowerShell:

irm https://www.texttocad.dev/install.ps1 | iex

It does six things, and nothing else:

  1. Installs uv if it is missing. Where uv is older than 0.9.0, it updates it, or installs a newer one beside it with uv's own installer.
  2. Installs cad, the command text-to-cad runs on, as a uv tool, at the newest release. Where cad is installed already, it leaves it as it is: cad updates itself. Where that cad does not start, it installs it again.
  3. Installs or updates the plugin in each agent app it finds, with that app's own command (below), all but Kimi Code, which you install by hand. It prints one line per app; in a terminal it first builds the CAD logo, and a live line under the others names the app it is setting up and the command it is running (NO_COLOR turns that off).
  4. Removes what earlier releases of text-to-cad left in those apps.
  5. Where cad's folder is not on your PATH, runs uv's own uv tool update-shell, which adds it for new terminals (on macOS and Linux in your shell's profile, on Windows in your user PATH). Setting UV_NO_MODIFY_PATH stops that. cad sets it when cad itself runs the install command (cad plugin update, and when cad has been updated), so only your own run changes the PATH.
  6. Where cad is there, turns on the plugin's automatic updates (Updating). Where something above failed, it tells cad so, and cad runs the install command again later.

It takes no options and does not start anything. Run it again at any time to bring the plugin up to date in every app.

It removes only what is ours: a skill counts as ours only where its SKILL.md says it comes from text-to-cad's repository, so a skill of yours with the same name is left as it is. A copy from a plugin store (Codex's or Claude's) is never touched.

Your agent shows each model it makes in a viewer. In the Codex app that is a CAD tab beside the thread; every other app opens it in its own browser, or gives you a link to open in yours.

On Windows, run it in Windows Terminal or PowerShell, not in a Windows Store app's shell such as the Claude desktop app's: Windows can keep what such an app's commands write inside that app, where no terminal and no other app finds it. The command names www.texttocad.dev because Windows PowerShell 5.1 does not follow the redirect from texttocad.dev.

Install by hand

First install cad, which needs uv:

uv tool install cad

If uv says the cad executable already exists, add --force after install. cad updates itself (Updating). The runtime supports Python 3.11+.

Then install the plugin in each app with the commands under its name. Install it once per app: two copies show every skill twice. Restart the app afterwards. The plugin's skills run text-to-cad through the cad command; when it is missing, the skill tells your agent how to install it.

The commands take the latest branch: the plugin alone, moved to each release once it is on PyPI. Devin CLI, Antigravity and Factory Droid cannot name a branch here and install main, where development happens.

Claude Code, Codex and Cursor are tested before every release. Gemini CLI, Grok Build and Hermes Agent are installed on the computer we test on. The other entries follow each vendor's documentation.

Claude Code

claude plugin marketplace add earthtojake/text-to-cad#latest
claude plugin install text-to-cad@earthtojake

Claude Code shows models in its browser pane or your browser. Claude Desktop's Code tab runs Claude Code and uses the same plugin. The install command adds it with the claude command; without that command, add it in Claude Code's plugin manager with the two commands above.

To update:

claude plugin marketplace update earthtojake
claude plugin update text-to-cad@earthtojake

Codex

Codex app

text-to-cad is in the official Codex plugin directory.

  • In the Codex app, click Plugins in the sidebar.
  • Find text-to-cad.
  • Click the + next to it and follow the prompts.

Codex CLI

text-to-cad is in the official Codex plugin directory.

  • Open the plugin search:

    /plugins
  • Search for text-to-cad:

    text-to-cad
  • Select Install Plugin.

The directory updates its copy.

From this repository

Or install it from this repository:

codex plugin marketplace add earthtojake/text-to-cad --ref latest
codex plugin add text-to-cad@earthtojake

To update:

codex plugin marketplace upgrade earthtojake
codex plugin add text-to-cad@earthtojake

In the Codex app the plugin also brings the viewer: CAD in the sidebar, a CAD tab beside each thread, and Open with CAD for model files. It is the only app that gets it.

Cursor

git clone --depth 1 --branch latest https://github.com/earthtojake/text-to-cad ~/.cursor/plugins/local/text-to-cad

Cursor also loads the plugin installed in Claude Code: if Claude Code has it, skip this. Cursor shows models in its browser.

To update:

git -C ~/.cursor/plugins/local/text-to-cad pull

Gemini CLI

gemini extensions install https://github.com/earthtojake/text-to-cad --ref latest --consent

To update:

gemini extensions update text-to-cad

Grok Build

grok plugin install earthtojake/text-to-cad@latest --trust
grok plugin enable text-to-cad

Grok Build also loads the plugin installed in Claude Code: if Claude Code has it, skip this.

To update:

grok plugin update text-to-cad

Antigravity

agy plugin install https://github.com/earthtojake/text-to-cad

To update, run the same command again.

Devin CLI

devin plugins install earthtojake/text-to-cad

To update: devin plugins update text-to-cad.

Factory Droid

droid plugin marketplace add earthtojake/text-to-cad
droid plugin install text-to-cad@text-to-cad --scope user

To update: droid plugin marketplace update text-to-cad, then droid plugin update text-to-cad@text-to-cad --scope user.

GitHub Copilot CLI

copilot plugin marketplace add earthtojake/text-to-cad#latest
copilot plugin install text-to-cad@earthtojake

To update:

copilot plugin update text-to-cad

Kimi Code

Type this inside Kimi Code:

/plugins install https://github.com/earthtojake/text-to-cad/tree/latest

To update, type it again. The install command cannot do this one for you.

Muse

git clone --depth 1 --branch latest https://github.com/earthtojake/text-to-cad
muse plugins install ./text-to-cad
muse plugins approve text-to-cad

Muse keeps its own copy, so the clone can be deleted afterwards.

To update:

muse plugins update text-to-cad

Pi

pi install git:github.com/earthtojake/text-to-cad@latest

To update, run the same command again: pi update does not move a named branch.

Qwen Code

qwen extensions install https://github.com/earthtojake/text-to-cad --ref latest --consent

To update:

qwen extensions update text-to-cad

Other agents

These agents take the skills alone, copied into their own skills folder. The install command does it for each one it finds.

AgentSkills folder
Amp~/.config/amp/skills
Cline~/.cline/skills
Goose~/.config/goose/skills
Hermes Agent~/.hermes/skills ($HERMES_HOME/skills where that is set)
Kilo Code~/.kilo/skills
Kiro CLI~/.kiro/skills
OpenClaw~/.openclaw/skills
OpenCode~/.config/opencode/skills
Roo Code~/.roo/skills
Trae~/.trae/skills
Windsurf~/.codeium/windsurf/skills

By hand, copy each folder under skills/ on the latest branch into the agent's folder, for example for Cline:

git clone --depth 1 --branch latest https://github.com/earthtojake/text-to-cad text-to-cad
mkdir -p ~/.cline/skills
cp -R text-to-cad/skills/* ~/.cline/skills/

To update, copy them again, or run the install command.

Earlier releases installed a Hermes Agent plugin instead. The install command removes it; by hand, run hermes plugins remove text-to-cad.

Zed and GitHub Copilot in VS Code are not supported yet. No route for your agent? Request one.

Updating

cad and the plugin update separately.

cad

cad updates itself to every new release of its major version (the first number: 0 in 0.12.3). While its server runs, it looks for a new release about once an hour, and installs it once nothing has run for a minute. To update it now:

cad update

That updates cad alone. A new major version never installs itself, because it may need changes on your side: cad update and cad doctor say when one is out, and this installs it:

cad update --major

The migration guides say what changes. Automatic updates are on unless you turn them off. To see whether they are on, or to turn them off or on:

cad update auto        # says whether they are on
cad update auto off
cad update auto on

A cad installed with uv tool install cad updates itself; one installed with pip into a project's own Python never does. Setting CAD_UPDATE_CHECK=0 (or CI) where cad runs turns the check off for that process, and makes cad update refuse there too. You can also update cad with uv yourself:

cad server stop
uv tool upgrade cad
cad server start

Once cad has updated itself, uv keeps it inside its major version, so uv tool upgrade cad does too; uv tool install cad@latest takes the newest of all.

The plugin

The install command turns on the plugin's automatic updates: each time cad is newer than the release the install command last ended well for, cad runs the install command once, in the background, which puts the newest plugin in every agent app it finds. That holds however cad got newer: by itself, by cad update, or by uv tool upgrade cad or pipx upgrade cad. It happens the next time cad's server starts or looks after itself with nothing running. A run that fails, or that is still running after 15 minutes and is stopped, is tried again an hour or more later: at most three runs for one release. To update the plugin now, run the install command again, or:

cad plugin update

To update one app alone, run the update command under its name. To see whether the plugin's automatic updates are on, or to turn them off or on:

cad plugin update auto        # says whether they are on
cad plugin update auto off
cad plugin update auto on

They are off until a run of the install command turns them on: cad never changes your apps where you did not run it.

A copy from a plugin store (Codex's or Claude's) is updated by that store, on its own schedule. Its skills may then be older than cad. That is fine: a command the skills used keeps working for at least 30 days after the skills stop using it.

Staying on an older release

Turn automatic updates off, then install the release you want, for example 0.11.12:

cad update auto off
cad server stop
uv tool install cad==0.11.12
cad server start

The install command leaves that cad as it is. It still puts the newest plugin in your apps, and its skills may ask for a newer cad.

From an earlier release

A computer on 0.10.0 to 0.11.11 is brought over once, by the updater those releases shipped: it installs the new cad with uv. Where the install command was used on that computer, it runs it once more and turns on the plugin's automatic updates; where it was not, your apps are left as they are. From then on, both update as above. A computer on an older release moves when you run the install command.

Removing

Remove the plugin from each app with that app's own command:

AppRemove
Claude Codeclaude plugin uninstall text-to-cad@earthtojake, then claude plugin marketplace remove earthtojake
Codexcodex plugin remove text-to-cad@earthtojake, then codex plugin marketplace remove earthtojake
Cursorrm -rf ~/.cursor/plugins/local/text-to-cad
Gemini CLIgemini extensions uninstall text-to-cad
Grok Buildgrok plugin uninstall text-to-cad
Antigravityagy plugin uninstall text-to-cad
Devin CLIdevin plugins remove text-to-cad
Factory Droiddroid plugin uninstall text-to-cad@text-to-cad, then droid plugin marketplace remove text-to-cad
GitHub Copilot CLIcopilot plugin uninstall text-to-cad, then copilot plugin marketplace remove earthtojake
Pipi remove git:github.com/earthtojake/text-to-cad@latest
Qwen Codeqwen extensions uninstall text-to-cad
Kimi Code, Museremove text-to-cad in the app's plugin manager
Other agentsdelete our skills from the agent's skills folder

Then stop cad's server and remove cad:

cad server stop
uv tool uninstall cad

That removes the program. Your settings, Recents and the records of your models stay in two folders, which you can delete by hand:

DataCache
macOS~/Library/Application Support/cad~/.cache/cad
Linux~/.local/state/cad~/.cache/cad
Windows%USERPROFILE%\.local\state\cad%USERPROFILE%\.cache\cad

cad doctor and cad cache dir print where they are on your computer; run them before you remove cad. What uv downloaded stays in uv's cache until you run uv cache prune.

What it needs

  • A network connection to install cad, and again the first time a model is built, when cad fetches the CAD kernel (OCP and build123d). cad itself is about 110 MB on disk; the kernel about 620 MB.
  • On Linux, the system's OpenGL library, libGL.so.1 (the libgl1 package on Debian and Ubuntu).
  • On Windows 11, Smart App Control turned off, or WSL. The CAD kernel's wheel ships an unsigned native module, which Smart App Control blocks: every cad command and import build123d then fails with ImportError: DLL load failed while importing OCP, and Event Viewer records Event ID 3077 under CodeIntegrity › Operational. Smart App Control has no per-app exception; turning it off is under Settings › Privacy & security › Windows Security › App & browser control › Smart App Control settings, and once off it can be turned back on only by reinstalling Windows. Under WSL it does not apply.