Skip to main content
ExodeUI

EXODEUI DESKTOP

A little space for good ideas.

Choose your platform to get the official ExodeUI installer.

Looking for Intel Mac or other builds? Explore the web studio or check all download options.

Prefer the browser? Try for free in your browser →
@exodeui/cli

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.

bash
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 browser

Install

You need Node 18.17 or newer and Google Chrome, which the CLI renders with. ffmpeg is only needed for exode video.

bash
npm i -g @exodeui/cli      # then: exode
npx @exodeui/cli --help    # or run it without installing
exode doctor               # checks Node, Chrome, ffmpeg and the engine

Run 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.

bash
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 login again.
  • Always free: login, logout, whoami, doctor, docs and --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

bash
exode create launch-card    # scene.js, tests/, AGENTS.md, .mcp.json
cd launch-card
exode dev                   # opens the live preview

Edit 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:

bash
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

FileWhat it is
scene.jsOptional. A script that generates the scene with the Exode kit: loops, maths, palettes, staggers. Good for code and AI agents.
build/scene.exodeThe design file. With scene.js it is rebuilt on every save. Without it, scene.exode is the source.
dist/scene.bexodeThe compact binary you ship to the runtimes (web, React, Vue, Svelte, React Native, iOS, Android, Flutter). Made by exode build.
tests/*.testInteraction tests.
exode.jsonProject settings: name and scene file.
AGENTS.md · .mcp.jsonTell 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

CommandWhat it does
exode create <name> [--from <id>]New project from the starter, a recipe or an example.
exode samplesList what you can start from.
exode initAdd exode.json, AGENTS.md and .mcp.json to a folder that already has a scene.

Build

CommandWhat 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 inspectLayers, 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

CommandWhat it does
exode shot [--do <action>]… -o shot.pngRender 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

CommandWhat it does
exode video -o out.mp4MP4, 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 openOpen the scene in the ExodeUI editor.

More

CommandWhat it does
exode convert <file.riv | lottie.json>Bring Rive and Lottie files into Exode as native, editable objects.
exode doctorCheck Node, Chrome, ffmpeg, the engine and the project.
exode mcpRun the Exode MCP server over stdio.
exode login · logout · whoamiYour account and plan.

The action language

The same lines work in exode shot --do '<action>' and in test files.

actions
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 frame
bash
exode 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 changed

Tests

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.

tests/card.test
## 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-errors
expectations
expect 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 threw

Run 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).

bash
cd my-scene
claude          # Claude Code picks up CLAUDE.md and .mcp.json

Then 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.

bash
exode login --print-token     # copy the token it prints
github actions
- 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.

ProblemFix
Sign in to use ExodeUIRun exode login.
Your 30-day ExodeUI trial has endedGet a plan at exodeui.com/pricing, then exode login.
Couldn't reach ExodeUI to confirm your planYou've been offline for more than 3 days. Reconnect and run the command again.
Your sign-in has expiredRun exode login again.
The browser doesn't open on loginCopy the link it prints, or use exode login --no-browser.
chrome … not foundInstall Google Chrome, or set EXODE_CHROME to a Chromium binary.
exode video failsInstall ffmpeg (brew install ffmpeg on macOS).
A starting animation doesn't play in an older fileexode fix scene.exode
exode runs an old versionCheck 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.