export

Request an export of the selected composition.

Install the local runtime using Agent plugins. The npm CLI is a thin client and does not bundle the bridge, editor, or rendering dependencies. The examples assume @editframe/cli is already installed in your project and use explicit paths; replace them with your project and installed bridge paths. A verified component installation can use --component /absolute/installed/component instead of --bridge.

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

Reads a CreateExportRequest JSON file, up to 8 MiB, and prints a job. Supply operation_id, revision_id, execution_target (local or hosted), and settings containing container, video_codec, audio_codec, width, height, and fps. Read context for supported formats and limits. For local browser export, keep the editor open and connected as the renderer. This command submits work; it does not save a video file. Follow the returned job with job.

For an enabled hosted runtime, replace the local connection flags with --endpoint https://your-host/v2/agent and --project-id PROJECT_ID, and set EDITFRAME_TOKEN in the process environment. projects does not require a project ID. Hosted access depends on the endpoint and account being enabled; see Agent plugins for currently available installation choices.

Flags

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