CLI

The CLI is a client for the public REST API. It installs two names for the same program: embodiflow and ef. Output is JSON when stdout is not a terminal; add --json to force it, or --output table for a table. Every command accepts --api-base-url <url> and --profile <name>.

Install

The package is @embodiflow/cli, published to the GitHub Packages registry for the organization. You need read access to it.

npm install --global @embodiflow/cli --registry=https://npm.pkg.github.com
embodiflow --help

Sign in

auth login opens a browser sign-in. Use --pat to paste a personal access token, or --pat-stdin to read it from standard input in automation. The default API base URL points at a development API, so pass your own.

embodiflow auth login --base-url https://api.embodiflow.com
embodiflow whoami --json

whoami prints the email, active team, token kind, scopes and expiry. embodiflow auth logout removes the saved credential. embodiflow config doctor checks connectivity.

Main commands

Projects

embodiflow projects list --json

embodiflow projects create --name "Pick and place"

Upload

embodiflow uploads create --project-id <project-id> --source-path ./recordings

uploads plan takes the same --source-path and prints a read-only plan. recordings upload <path> --project <team>/<project> creates one named recording.

Workflow runs

embodiflow workflow runs list --project-id <project-id>

embodiflow workflow runs wait <run-id>

Exports and downloads

embodiflow exports create --project-id <project-id> --version-number 1

embodiflow versions download <team>/<project>@1 --format lerobot-v3

exports status, exports wait and exports download take --project-id, --version-number and --export-id. resolve <ref> turns a team/project@n reference into ids.

Training

embodiflow training jobs list --project-id <project-id>

Webhooks

embodiflow webhook-endpoints create --url https://example.com/hooks --event-types workflow.run.succeeded

The signing secret is shown once. See Signature verification for how to check a delivery.

Discover more

embodiflow schema commands --json
embodiflow <command> --help

schema commands prints the machine-readable command registry, which is the source for this page.

Exit codes

• 0 success.
• 1 command failure: API error, validation, not found or missing authentication.
• 2 usage error: unknown command or missing argument.