The ExodeUI CLI
Create, preview, test and ship interactive .exode motion from your terminal, with your AI agent working alongside you. Every command runs on the real Exode engine, the same one the editor and the runtimes use, so results are the same on every run.
npm i -g @exodeui/cli
exode login # new accounts get a free 30-day trial
exode create my-scene
cd my-scene && exode dev # live preview in the browserInstall
You need Node 18.17 or newer and Google Chrome, which the CLI renders with. ffmpeg is only needed for exode video.
npm i -g @exodeui/cli # then: exode
npx @exodeui/cli --help # or run it without installing
exode doctor # checks Node, Chrome, ffmpeg and the engineRun exode on its own to see the welcome screen with tips and your recent projects.
Sign in, trial and plans
The CLI uses your ExodeUI account, the same one as the editor.
exode login # opens your browser: Continue with Google or Apple
exode whoami # your account and plan: trial days left, or Pro / Enterprise
exode logout # sign out on this machine- Free trial: new accounts get 30 days. The trial belongs to your account, so it's the same trial in the editor, the CLI and the MCP.
- After the trial: commands that make or export something need a plan. Get one on the pricing page, then run
exode loginagain. - Always free:
login,logout,whoami,doctor,docsand--help, so you can always see what's wrong and fix it. - Offline: your plan is checked online and remembered for up to 3 days, so you can keep working without a connection.
Your sign-in is stored in ~/.exode/ and readable only by you.
Your first project
exode create launch-card # scene.js, tests/, AGENTS.md, .mcp.json
cd launch-card
exode dev # opens the live previewEdit scene.js and save: the preview rebuilds instantly. Hover and click in the preview to try interactions, change inputs from the side panel, and record a test from what you do.
Or start from something finished:
exode samples # starters, recipes and examples
exode create pricing --from pricing # a recipe (scene.js)
exode create kip --from kip-character-rig # a finished piece (scene.exode)Project files
| File | What it is |
|---|---|
| scene.js | Optional. A script that generates the scene with the Exode kit: loops, maths, palettes, staggers. Good for code and AI agents. |
| build/scene.exode | The design file. With scene.js it is rebuilt on every save. Without it, scene.exode is the source. |
| dist/scene.bexode | The compact binary you ship to the runtimes (web, React, Vue, Svelte, React Native, iOS, Android, Flutter). Made by exode build. |
| tests/*.test | Interaction tests. |
| exode.json | Project settings: name and scene file. |
| AGENTS.md · .mcp.json | Tell your AI agent how to work here and connect the Exode MCP. |
Commands
Every command takes --json for scripts and agents, and exode <command> --help lists all options.
Start
| Command | What it does |
|---|---|
| exode create <name> [--from <id>] | New project from the starter, a recipe or an example. |
| exode samples | List what you can start from. |
| exode init | Add exode.json, AGENTS.md and .mcp.json to a folder that already has a scene. |
Build
| Command | What it does |
|---|---|
| exode dev [--port 4180] | Live preview: reloads on save, input controls, live state, test recorder. |
| exode check [--strict] | Compile, validate, design review, then run it on the engine. Exits 1 on errors. |
| exode inspect | Layers, animations, state machine and inputs. |
| exode docs [topic] | The scene kit, the action language and the motion-design guides. |
| exode fix [file | folder] [--dry-run] | Update older .exode files so their starting animations play on load. |
Drive
| Command | What it does |
|---|---|
| exode shot [--do <action>]… -o shot.png | Render one frame after driving the scene. --probe x,y reads a colour; --compare base.png diffs against a baseline. |
| exode test [--grep name] | Run tests/*.test. |
| exode frames [-o sheet.png] | A contact sheet across the whole animation. |
Ship
| Command | What it does |
|---|---|
| exode video -o out.mp4 | MP4, WebM, GIF, MOV (ProRes 4444 with alpha) or PNG sequence. --fps, --duration, --size, --scale 2, --set, --pointer, --transparent. |
| exode build [-o file.bexode] | Compile to .bexode and verify it renders the same as the source. |
| exode export <bexode | web | exode> | web: one offline HTML page that runs the project. |
| exode open | Open the scene in the ExodeUI editor. |
More
| Command | What it does |
|---|---|
| exode convert <file.riv | lottie.json> | Bring Rive and Lottie files into Exode as native, editable objects. |
| exode doctor | Check Node, Chrome, ffmpeg, the engine and the project. |
| exode mcp | Run the Exode MCP server over stdio. |
| exode login · logout · whoami | Your account and plan. |
The action language
The same lines work in exode shot --do '<action>' and in test files.
wait 0.5 advance time: 0.5 · 0.5s · 500ms · 30f
click 640,360 press and release (also: tap); points are artboard pixels or 50%,50%
click "Buy button" pointer verbs also take a layer name
hover "Card" move the pointer there (also: move) · leave
down x,y · up x,y press / release
drag 100,100 500,100 [0.4s]
wheel 0,240 [x,y] scroll
key Space [down|up] a key, named like KeyboardEvent.key
set speed=2 set a state machine input
fire burst fire a trigger input
shot frame.png save the current frameexode shot --do 'wait 1' --do 'hover "Buy button"' --do 'wait 0.3' -o hover.png
exode shot --do 'set theme=1' --probe 40,40 --json
exode shot --compare baseline.png --max-diff 0.5 # fails if more than 0.5% of pixels changedTests
A test file is plain text: ## name starts a case, then one action or expectation per line. Every case starts from a fresh scene at t=0.
## the button answers hover and press
wait 1.5s
hover "Trial button"
expect state Hover
click "Trial button"
wait 0.1s
expect state Feedback=Bounce*
expect no-errorsexpect state Hover some layer is in state "Hover"
expect state Base=Hover layer "Base" is in state "Hover"
expect state Base=Pop* …a state whose name starts with "Pop"
expect input count=3 an input's current value
expect pixel 10,10 #FF4A1C 16 colour at a point, with a tolerance 0–255
expect no-errors nothing threwRun them with exode test (or exode test --grep button). A failing case saves its frame to build/test-failures/. You can also record tests in exode dev by clicking around.
AI agents and the MCP
exode create sets up everything an agent needs: AGENTS.md and CLAUDE.md explain the project and the commands to run after each change, and .mcp.json connects the Exode MCP (160+ tools for objects, keyframes, state machines, physics, plugin designs and conversions).
cd my-scene
claude # Claude Code picks up CLAUDE.md and .mcp.jsonThen ask, for example: "Make the button glow on hover and add a test for it." Cursor reads .mcp.json when you open the folder. Other MCP clients can run npx -y claude-exode-mcp or exode mcp. See the MCP guide for more.
The MCP uses the same account as the CLI. If it says you need to sign in, run npx @exodeui/cli login in a terminal once.
CI and scripts
Every command takes --json and exits non-zero on failure. To sign in on a CI machine, create a token once on your own machine and store it as the EXODE_TOKEN secret. Treat it like a password: anyone who has it can use your plan.
exode login --print-token # copy the token it prints- run: npm i -g @exodeui/cli
- run: exode check --strict && exode test && exode build
env:
EXODE_TOKEN: ${{ secrets.EXODE_TOKEN }}Colour and spinners turn off automatically in pipes, with NO_COLOR, and when an AI agent runs the CLI.
Troubleshooting
Run exode doctor first: it checks most of these.
| Problem | Fix |
|---|---|
| Sign in to use ExodeUI | Run exode login. |
| Your 30-day ExodeUI trial has ended | Get a plan at exodeui.com/pricing, then exode login. |
| Couldn't reach ExodeUI to confirm your plan | You've been offline for more than 3 days. Reconnect and run the command again. |
| Your sign-in has expired | Run exode login again. |
| The browser doesn't open on login | Copy the link it prints, or use exode login --no-browser. |
| chrome … not found | Install Google Chrome, or set EXODE_CHROME to a Chromium binary. |
| exode video fails | Install ffmpeg (brew install ffmpeg on macOS). |
| A starting animation doesn't play in an older file | exode fix scene.exode |
| exode runs an old version | Check which exode; an older alias or install may come first on your PATH. |
Questions
How do I install the ExodeUI CLI?+
Install Node 18.17 or newer and Google Chrome, then run npm i -g @exodeui/cli. Run exode doctor to check your setup and exode login to sign in.
Is the ExodeUI CLI free?+
New ExodeUI accounts get a free 30-day trial that covers the editor, the CLI and the MCP. After the trial, commands that make or export something need a plan from exodeui.com/pricing. login, logout, whoami, doctor and docs always work.
Can I use the CLI in CI?+
Yes. Run exode login --print-token once on your machine, store the token as the EXODE_TOKEN secret, and use --json output. Commands exit non-zero on failure.
Does the CLI work with Claude Code and Cursor?+
Yes. exode create writes AGENTS.md, CLAUDE.md and a .mcp.json that connects the Exode MCP, so Claude Code and Cursor can build and test scenes in the project straight away.