Osmo CLI

Create and edit animations locally with Osmo Studio, share videos, collect feedback, and run AI models.

npm install -g @osmo.inc/cli
osmo login                # prints a link: open it and approve
osmo login                # again, to finish signing in
osmo share ./video.mp4

Runs on any OS with Node 22 or later. Sharing a video also needs ffprobe, which comes with FFmpeg: brew install ffmpeg on macOS, sudo apt install ffmpeg on Debian or Ubuntu, winget install ffmpeg on Windows.

Create and edit locally

osmo studio init my-animation
cd my-animation
osmo studio open
osmo studio check
osmo studio render

Local editing and rendering need no Osmo account. open starts the local browser editor and prints its address; it keeps running while you edit. Read the generated AGENTS.md before authoring with an agent. render saves exports/scene.mp4.

Local Studio supports Apple Silicon macOS and Linux x64/arm64 with glibc. It needs Git 2.29+ for project setup and FFmpeg with libx264 plus ffprobe for video rendering. Linux machines without a GPU need Mesa's software Vulkan driver. The native renderer and scene package come with the matching CLI platform package; Rust is not required. Other CLI commands remain available on platforms without Studio.

When you want a review link for this project, run osmo login, then osmo studio deploy. This uploads the source and video to one project review page. Use osmo studio clone PROJECT to copy an accessible project for local editing. Old web-editor projects download into legacy-<id>/ with README.md, project.json, animations/, and assets.json. These are conversion materials, not runnable local projects: media remains as URLs, and no Git history or cloud sync connection is created. Pass a folder argument to override the destination. Cloud operations require login and retain existing source permissions.

Share a video and collect feedback

Upload a video from any tool and get a review link with timestamped comments and version history. No project setup or Git repository is needed.

osmo share ./video-v2.mp4 --to SHARE
osmo shares
osmo comments list SHARE --open --json
osmo comments reply COMMENT "Fixed in the latest version."
osmo unshare SHARE

SHARE is a share's link or its ID; osmo shares lists yours. A comment is addressed by its ID alone. osmo unshare turns a share's links off and keeps everything; osmo shares delete SHARE --yes removes it for good. Accepts H.264 MP4 with optional AAC audio, up to 2 GiB.

Resources and AI models

osmo resources list
osmo resources show osmo/z-image-turbo
osmo run osmo/z-image-turbo --input prompt="a red bicycle on a quiet street" --out bike.jpg
osmo jobs

osmo resources lists the AI models that run on Osmo, charged to your plan. osmo resources show ID lists a model's inputs. The catalog also holds packages for Osmo scenes, such as shaders and 3D models, which osmo resources get downloads.

Every command takes --json and --help.

Sharing guide · AI agent setup

Usage

osmo usage shows your personal plan’s monthly percentage used, reset time, and Plan & Usage link, matching the web usage dropdown. Use osmo usage --workspace SLUG for the same billing context as osmo run --workspace SLUG; if billing falls back to your personal plan, the output labels that plan explicitly. This is read-only and also works with a login created using --no-spend.

osmo usage --json returns status (ok, exhausted, or no_plan), context, plan, limits (percent used and exact reset timestamps), and billingUrl. A blocked plan also includes reason, resetsAt, and guidance in message. An exhausted plan is a successful status read (exit 0); authentication, network, and permission failures exit 1. Raw internal billing units are never returned.