command

Apply an explicit revisioned composition command.

Install the local runtime once per computer with editframe setup. The npm CLI is a thin client and does not bundle the bridge, editor, or rendering dependencies. Local commands use the runtime setup installed; --bridge /absolute/editframe-bridge or --component /absolute/installed/component selects another. The examples assume @editframe/cli is installed in your project; replace /absolute/project with your project's path.

npx editframe command --project /absolute/project --composition COMPOSITION_ID --input command.json

Reads a CommandRequest JSON file, up to 8 MiB, and prints the operation receipt. Supply operation_id, base_revision_id, kind, and label, plus the fields needed by that command kind. Supported kinds are replace_html, patch_html, patch_source, restore, and undo. Read context first. The CLI never invents operation or revision IDs. Reuse an operation ID only when retrying the identical request; after a revision conflict, refresh context and make a new operation.

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.

Flags

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