Commands

Command	Description
`init [name]`	Scaffold a new Remotion project
`init --starter social`	New project + captioned social clip recipe pre-installed
`init --starter podcast`	New project + podcast clip recipe pre-installed
`init --existing`	Bootstrap `remotion-ui.json` in an existing Remotion project
`add <name...>`	Install components and dependencies
`add --recipe <slug>`	Install a task-first recipe (components + deps)
`doctor`	Diagnose config, aliases, and Remotion version
`list`	List registry components and installed status
`update <name...>`	Re-install from registry (overwrites files)
`diff <name>`	Compare installed files vs registry
`search -q <query>`	Search the registry
`view <name>`	View registry item metadata
`build [registry.json]`	Build a custom registry to `public/r/`

Diagnose setup

Doctor

$ npx remotion-ui@latest doctor

Checks remotion-ui.json, tsconfig path aliases, install directories, and Remotion version alignment.

Existing Remotion project

Existing project

cd your-remotion-app
npx remotion-ui@latest init --existing
npx remotion-ui@latest add social-clip

Starter projects

Ship a social or podcast clip in one session:

Social starter

npx remotion-ui@latest init my-reel --starter social
cd my-reel && npm run dev
npx remotion render src/Root.tsx SocialClip out/social-clip.mp4

Podcast starter

npx remotion-ui@latest init my-podcast --starter podcast
cd my-podcast && npm run dev
npx remotion render src/Root.tsx PodcastClip out/podcast-clip.mp4

Use --starter default (or omit) for the blank Welcome composition template.

Recipe install

Install

$ npx remotion-ui@latest add --recipe captioned-social-video

Recipes are defined in /ai/recipes.json. Browse goals at Recipe wizard.

Script output

JSON output

npx remotion-ui@latest doctor --json
npx remotion-ui@latest search -q social --json
npx remotion-ui@latest view social-clip --json
npx remotion-ui@latest list --json

Workflow: staying up to date

Diff

$ npx remotion-ui@latest diff fade-in

Update

$ npx remotion-ui@latest update fade-in

Custom registry

Build registry

$ npx remotion-ui@latest build ./registry.json -o ./public/r

Config: remotion-ui.json

Config

{
"preset": "default",
"aliases": {
  "primitives": "@/remotion/primitives",
  "scenes": "@/remotion/scenes",
  "compositions": "@/compositions",
  "lib": "@/remotion/lib",
  "hooks": "@/remotion/hooks"
}
}

CLI Reference