context

Read a composition's revision and editing context.

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 context --project /absolute/project --bridge /absolute/editframe-bridge --composition COMPOSITION_ID

Prints the document, current revision, composition, project, and runtime capabilities. Read this before editing or exporting; use the returned revision ID explicitly in your request.

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.