Guides

Automate rendering

Submit a revisioned export through the installed runtime and inspect its job.

Use the thin CLI to connect automation to the same runtime as the browser editor. Install the runtime from Agent plugins, install @editframe/cli in your project, and substitute your actual project and bridge paths in these examples.

Connect and select a composition

bash

npx editframe start --project /absolute/project --bridge /absolute/editframe-bridge
npx editframe open --project /absolute/project --bridge /absolute/editframe-bridge
npx editframe compositions --project /absolute/project --bridge /absolute/editframe-bridge
npx editframe context --project /absolute/project --bridge /absolute/editframe-bridge --composition COMPOSITION_ID

Open the URL returned by open in your browser. Keep its bootstrap credential private. Create or choose a composition in the editor, then copy its composition ID and current revision ID from the CLI results.

Submit an export

Create export.json with an operation ID unique to this request, the revision ID returned by context, and export settings supported by that response's capabilities. For example, when MP4/H.264/AAC and these dimensions are supported:

json

{
  "operation_id": "export-demo-001",
  "revision_id": "REPLACE_WITH_CURRENT_REVISION_ID",
  "execution_target": "local",
  "settings": {
    "container": "mp4",
    "video_codec": "h264",
    "audio_codec": "aac",
    "width": 1280,
    "height": 720,
    "fps": 30
  }
}

bash

npx editframe export --project /absolute/project --bridge /absolute/editframe-bridge --composition COMPOSITION_ID --input export.json
npx editframe job --project /absolute/project --bridge /absolute/editframe-bridge --job JOB_ID

Replace JOB_ID with the returned job ID. Keep the editor open and connected as the local renderer while the job runs. Inspect its terminal state and any error before retrieving the artifact in the editor. The CLI submits and inspects jobs; it does not write an MP4 automatically.

Reuse an operation ID only for an identical retry. A new revision or changed export settings require a new operation ID.

Existing cloud applications

Existing cloud render integrations use the render API. Runtime --endpoint access is a separate connection mode and requires an enabled runtime endpoint and account. Use the installation page to see which connection modes are currently available.

If a previous script uses render, auth, or cloud-render, follow CLI migration.