render

Render a composition to an MP4 file.

Install the local runtime using Agent plugins, and install Google Chrome or Chromium. The npm CLI is a thin client: render starts the installed bridge, opens the composition in a private headless editor, exports the current revision, and writes the file. Select the installed runtime with --bridge or --component, or set EDITFRAME_BRIDGE_PATH or EDITFRAME_COMPONENT_ROOT.

npx editframe render -o output.mp4 --bridge /absolute/editframe-bridge

--project defaults to the current directory, and -o defaults to output.mp4. The composition comes from --composition, then from the entry declared in editframe.config.mjs, then from the project's only composition. A project with several compositions and no configured entry fails with the list of identifiers to pass to --composition.

CHROME_PATH selects the browser; otherwise the CLI searches standard Chrome and Chromium installations. Progress goes to stderr. After writing the file, the CLI prints JSON with the output path, byte size, SHA-256, job, project, composition and revision identifiers, dimensions, frame rate, and duration.

render runs on the local runtime only and rejects --endpoint. Use export and job to submit work without waiting for a file, or the Renders API to render in Editframe's cloud.

Flags

The table includes shared parser options; use the connection and command-specific flags shown above.