List compositions in the selected project.
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 compositions --project /absolute/projectPrints composition metadata. Copy a composition ID into the --composition argument for context, command, or export.
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.
| Flag | Default | Description |
|---|---|---|
-h, --help | — | Show usage |
--version | — | Show the CLI version |
--project <value> | — | Absolute local project directory |
--bridge <value> | — | Installed bridge executable |
--component <value> | — | Installed signed component directory |
--registry <value> | — | Local bridge registry directory |
--editor <value> | — | Verified editor asset directory |
--editor-version <value> | — | Verified editor version |
--compiler-pack <value> | — | Verified compiler pack file |
--compiler-pack-sha256 <value> | — | Expected compiler pack SHA-256 |
--endpoint <value> | — | Hosted runtime API endpoint |
--project-id <value> | — | Hosted project identifier |
--composition <value> | — | Composition identifier |
--input <value> | — | JSON request file with an explicit operation identity and revision |
--job <value> | — | Job identifier |
-o, --output <value> | — | MP4 file that render writes (default output.mp4) |