# Command reference

Generated from `editorbrain help` in the reviewed code. Arguments in brackets are optional; `ID`, `HASH`, `UUID` and file names are placeholders you replace. `a|b` means choose one. Do not run every line: pick the operation you need.

Read [Install and connect](https://editorbrain.com/en/docs/instalar), [Use the CLI](https://editorbrain.com/en/docs/cli) and [Versions and availability](https://editorbrain.com/en/docs/versiones) before you automate.

## version

```text
editorbrain version
```

## capabilities

```text
editorbrain capabilities
```

## guide

```text
editorbrain guide editing [path] [--section HEADING] [--cursor CURSOR] [--outline] [--expected-sha256 HASH]
```

## setup

```text
editorbrain setup --dir folder --agent codex|claude|both [--project id] [--workspace id] [--no-browser] [--skip-mcp]
```

## doctor

```text
editorbrain doctor [--dir folder] [--agent codex|claude|both] [--offline]
```

## init

```text
editorbrain init [--dir folder] [--brand id] [--style id] [--project id] [--topic text] [--goal text] [--agent codex|claude|both]
```

## onboarding

```text
editorbrain onboarding guide
editorbrain onboarding status --brand <brand-id> [--dir folder]
editorbrain onboarding create --brand ID [--project ID] [--dir folder] [--out .editorbrain-local/onboarding/new]
editorbrain onboarding serve --session path [--file draft.json] [--dir folder] [--timeout seconds] [--no-browser]
editorbrain onboarding apply --session path --file answers.json [--dir folder] [--dry-run]
editorbrain onboarding sync --session path [--dir folder] [--dry-run]
```

## resources

```text
editorbrain resources guide
editorbrain resources search [--query text] [--brand ID] [--kind logo|footage|product-fact] [--state draft|approved|archived] [--limit 20] [--after CURSOR]
editorbrain resources register --file local-video.mp4 (--brand ID | --shared) [--title text] [--kind footage|broll|demo|logo|image|audio] [--tags a,b] [--description text] [--moments identity,opening,explanation,demonstration,background,transition,closing] [--instructions text] [--upload]
editorbrain resources get UUID
editorbrain resources locate UUID [--dir folder]
editorbrain resources save UUID --file resource.json --expected-revision N [--user-confirmed]
editorbrain resources index UUID --file index.json --expected-revision N
editorbrain resources tempo UUID --job JOB_ID --mapping .editorbrain-local/tempo-input.json --expected-revision N
editorbrain resources segments UUID [--revision N] [--offset N] [--limit 30]
editorbrain resources attach UUID --project ID
```

## brain

```text
editorbrain brain status --brand ID
editorbrain brain prepare --brand ID [--revision N]
editorbrain brain accept --brand ID --run ID --revision N --reviewed
```

## update

```text
editorbrain update [--dir folder | --global | --all] [--dry-run]
```

## skill

```text
editorbrain skill install [--dir folder | --global] [--agent codex|claude|both]
editorbrain skill list
editorbrain skill pin|unpin [--dir folder]
```

## validate

```text
editorbrain validate [--dir folder]
```

## resolve

```text
editorbrain resolve <project-id> [--dir folder]
```

## export

```text
editorbrain export <project-id> --adapter neutral|hyperframes|remotion [--out folder] [--dir folder]
```

## login

```text
editorbrain login [--url https://server] [--no-browser] [--timeout seconds]
editorbrain login [--url https://server] --key-stdin
```

## workspaces

```text
editorbrain workspaces list
```

## register

```text
editorbrain register --url https://server --name workspace --invite-stdin
```

## status

```text
editorbrain status
```

## pull

```text
editorbrain pull [--project id | --all] [--dir folder] [--dry-run]
```

## push

```text
editorbrain push [--project id] [--dir folder] [--dry-run]
```

## batches

```text
editorbrain batches list [--after UUID]
editorbrain batches create --file batch.json
editorbrain batches get BATCH_ID
editorbrain batches pause|resume|cancel BATCH_ID --expected-revision N
editorbrain batches retry|detach BATCH_ID --project ID --expected-revision N
editorbrain batches claim|renew|release|attention BATCH_ID --project ID --lease-token UUID
```

## brands

```text
editorbrain brands list [--limit 20] [--after CURSOR]
```

## projects

```text
editorbrain projects list [--brand ID] [--query TEXT] [--since ISO] [--before ISO] [--sort recent|id] [--limit 20] [--after CURSOR]
editorbrain projects find "NAME OR TOPIC" [--brand ID] [--since ISO] [--before ISO] [--local] [--dir workspace]
editorbrain projects pin-style --project ID [--dry-run] [--dir folder]
editorbrain projects create ID --brand ID --style ID --output-profile ID [--name TEXT] [--topic TEXT] [--goal TEXT] [--dir folder]
editorbrain projects prepare --project ID [--dir workspace] [--dry-run]
editorbrain projects intake --project ID [--dir folder]
editorbrain projects link --project ID --path folder [--role work|renders|sources] [--dir workspace]
editorbrain projects unlink --project ID [--role work|renders|sources] [--dir workspace]
editorbrain projects progress --project ID
editorbrain projects start|queue --project ID --expected-version HASH
editorbrain projects complete --project ID --expected-version HASH --revision UUID --user-confirmed
```

## where

```text
editorbrain where ID [--dir workspace]
```

## resume

```text
editorbrain resume ID [--dir workspace] [--url https://server] [--rehash]
editorbrain resume --project ID [--dir folder] [--url endpoint] [--rehash]
```

## checkpoint

```text
editorbrain checkpoint --project ID --status not_started|in_progress|in_review|blocked|completed [--next TEXT] [--done TEXT ...] [--pending TEXT ...] [--decision TEXT ...] [--artifact work|renders|sources=relative/file ...] [--expected-checkpoint SHA256|none|current] [--current-version LABEL] [--primary-artifact work=scene.html] [--dependency work=runtime.js ...] [--render-command TEXT] [--dir workspace]
```

## agency

```text
editorbrain agency overview
editorbrain agency operations [--brand ID] [--limit 5] [--after CURSOR]
editorbrain agency settings --name NAME --reply-to EMAIL|none --expected-revision N --confirm
editorbrain agency limit --brand ID --credits N|none --expected-revision N --confirm
editorbrain agency portal --brand ID --id UUID --expected-portal UUID|none --confirm
editorbrain agency revoke-portal --brand ID --confirm
editorbrain agency approvals --out report.csv [--brand ID] [--month YYYY-MM] [--dir folder]
editorbrain agency credits --out report.csv [--brand ID] [--month YYYY-MM] [--dir folder]
editorbrain agency domain [--refresh]
editorbrain agency email-settings [--file settings.json --expected-revision N --confirm] [--dir folder]
editorbrain agency contacts --brand ID
editorbrain agency contact-add --brand ID --name NAME --email EMAIL [--locale es|en] --id UUID --confirm
editorbrain agency contact-revoke --contact ID --expected-revision N --confirm
editorbrain agency communications --brand ID
editorbrain agency communications --kind test
editorbrain agency email-preview --kind invitation|review|delivery|test [--contact ID] [--review ID] [--note TEXT] [--file settings.json] [--out preview.html] [--dir folder]
editorbrain agency email-send --kind invitation|review|delivery|test [--contact ID] [--review ID] [--note TEXT] --id UUID --preview-hash SHA256 --confirm
editorbrain agency email-retry --message ID --id UUID --confirm
```

## team

```text
editorbrain team access
editorbrain team members
editorbrain team projects
editorbrain team allowance --user USER_ID --credits N --expected-revision N --confirm
editorbrain team permissions --user USER_ID --file permissions.json --confirm
editorbrain team invite --email EMAIL --kind brand_editor|project_reviewer --scope ID
editorbrain team reviews --project ID [--after CURSOR]
editorbrain team comments --project ID --revision UUID [--after CURSOR]
editorbrain team share|withdraw --project ID --revision UUID --confirm
editorbrain team comment --project ID --revision UUID --context-version HASH --text TEXT --id UUID [--at-ms 1000]
editorbrain team approve --project ID --revision UUID --context-version HASH --user-confirmed
editorbrain team cancel --id INVITATION_ID
editorbrain team remove --user USER_ID --confirm
```

## documents

```text
editorbrain documents list [--prefix path]
editorbrain documents get <path> [--revision N]
editorbrain documents history <path> [--before N]
editorbrain documents restore <path> --revision N --expected-revision N
```

## search

```text
editorbrain search saved --query TEXT [--brand ID] [--project ID] [--limit 1..10] [--projects-after CURSOR] [--brands-after CURSOR] [--resources-after CURSOR] [--memory-after CURSOR]
editorbrain search brief --file <editorial-brief.json> [--project id] [--mode styles|events|both] [--review direct|directions|sample] [--details]
editorbrain search edit [--script file | --video file | --asset sha256 | --project id] [--requirements text] [--assets tag,tag] [--mode styles|events|both] [--review direct|directions|sample]
```

## memory

```text
editorbrain memory usage --project ID [--after RECEIPT_UUID | --file receipt.json]
editorbrain memory list --scope brand|style|project --id ID
editorbrain memory add --scope brand|style|project --id ID --text TEXT --status suggested|confirmed --expected-revision N [--brand ID (required for style)]
editorbrain memory confirm|disable ENTRY --scope brand|style|project --id ID --expected-revision N
```

## learning

```text
editorbrain learning save --file learning.json [--dir folder] [--user-confirmed]
editorbrain learning promote --file promotion.json --user-confirmed [--dir folder]
editorbrain learning consent [--file consent.json --user-confirmed] [--dir folder]
editorbrain learning signal --file signal.json [--dir folder]
```

## feedback

```text
editorbrain feedback add --project ID --text TEXT [--capture-memory] [--category captions|cuts|layout|motion|media|sound|color|story|other] [--conditions TEXT] [--preference-field FIELD --preference-value VALUE]
```

## improvements

```text
editorbrain improvements list --brand ID
editorbrain improvements accept RUN --index N --expected-revision N
```

## review

```text
editorbrain review list --project ID
editorbrain review create --project ID --asset SHA --title TEXT --kind sample|render --days 7 --share-authorized
editorbrain review revoke ID
```

## questions

```text
editorbrain questions plan --project id --file needs.json [--dir .]
```

## workflow

```text
editorbrain workflow prepare --project ID [--include-intake] [--previous-context session.json] [--render-override request.json] [--questions needs.json] [--reviews-after CURSOR] [--feedback-after CURSOR] [--studio-after CURSOR]
editorbrain workflow get
editorbrain workflow set --mode direct|directions|sample --expected-revision N
editorbrain workflow check [--summary | --details] [--project id] [--render-override request.json] [--previous-context workflow.json] [--questions needs.json] [--previous-version hash] [--previous-context-version hash]
```

## studio

```text
editorbrain studio prepare --file source.mp4 --out .editorbrain-local/studio/audio.wav [--audio-stream N]
editorbrain studio catalog
editorbrain studio voices [--language es] [--accent ACCENT] [--gender GENDER] [--query TEXT]
editorbrain studio voice --brand ID|--project ID
editorbrain studio voice VOICE_ID --brand ID|--project ID --expected-revision N
editorbrain studio quote --file request.json [--dir folder]
editorbrain studio run QUOTE_ID --max-credits N --user-confirmed [--batch-lease-token UUID]
editorbrain studio get JOB_ID
editorbrain studio jobs [--after UUID]
```

## billing

```text
editorbrain billing status
```

## integrations

```text
editorbrain integrations catalog
editorbrain integrations list [--details]
editorbrain integrations set <provider-id> --file settings.json --expected-revision N
```

## library

```text
editorbrain library favorites --brand brand-id
editorbrain library search [query] [--limit 10] [--after video-id]
editorbrain library get <video-id> [--document relative-source-path] [--sha256 source-hash]
editorbrain library media <video-id> --sha256 media-hash --out file
```

## narrative

```text
editorbrain narrative search [query] [--kind hook|cta|...] [--channel visual|spoken|...] [--limit 10]
editorbrain narrative get <video-id> [--sha256 document-hash] [--event-offset 0] [--relation-offset 0] [--limit 50]
```

## styles

```text
editorbrain styles list
editorbrain styles mine [--dir folder]
editorbrain styles share prepare <style-id> [--ids resource-id,resource-id] [--asset demo-resource-id]
editorbrain styles share publish --file reviewed-share.json
editorbrain styles share list
editorbrain styles share revoke <share-id> --user-confirmed
editorbrain styles template inspect <quoted-link>
editorbrain styles template import <quoted-link> --id new-style --expected-version SHA --request-id UUID --user-confirmed
editorbrain styles template status <import-id>
editorbrain styles source <id> --style-version <v> --out <archive> [--dir folder]
editorbrain styles prepare <id> --style-version <v> --file <archive> --out <new-directory> [--dir folder]
editorbrain styles create <style-id> [--from-project project-id] [--scene scene.html] [--name name] [--dir folder]
editorbrain styles push <style-id> [--with-resources] [--ignore-resource ID ...] [--dry-run] [--dir folder]
editorbrain styles pull <style-id> [--dry-run] [--dir folder]
editorbrain styles test <style-id> --project project-id [--dir folder]
editorbrain styles component extract --style ID --id ID --scene scene.html [--bindings bindings.json] [--dir folder]
editorbrain styles component prepare --style ID --id ID --parameters params.json --out new.html [--dir folder]
editorbrain styles component list --style ID [--dir folder]
editorbrain styles rules create --style ID --file rules.json [--dir folder]
editorbrain styles rules inspect --project ID [--dir folder]
editorbrain styles rules decisions --project ID --file decisions.json [--expected-version SHA256|none] [--dir folder]
editorbrain styles captions preview [--project ID] [--style ID] (--file words.json | --demo-text text) --out new.html [--video-out new.mp4] [--start seconds] [--duration seconds] [--dir folder]
editorbrain styles captions export [--project ID] [--style ID] --file words.json --format srt|ass --out new.srt [--dir folder]
editorbrain styles captions create --style ID --file captions.json [--dir folder]
editorbrain styles captions prepare [--project ID] [--style ID] --file cues.json --out new.html [--dir folder]
editorbrain styles techniques create --style ID --file techniques.json [--dir folder]
editorbrain styles check <style-id> [--dir folder]
editorbrain styles recommend <project-id> [--assets tag,tag] [--capabilities tag,tag] [--style pack-id] [--duration seconds]
```

## variants

```text
editorbrain variants create ID --project BASE --file changes.json [--dir folder]
editorbrain variants list --project BASE [--dir folder]
```

## clean

```text
editorbrain clean --project ID [--dir folder] [--deduplicate --confirm | --intermediates [--confirm]]
```

## media

```text
editorbrain media style create <style-id> --style <style-id> --file recipe.json [--dir folder]
editorbrain media styles [--category image|motion]
editorbrain media style <style-id> [--style-version 1.0.0]
editorbrain media inventory --input file-or-folder [--max-files 200] [--dir folder] [--out .editorbrain-local/report.json] [--details]
editorbrain media sample --file source --at 0,5,12 --out .editorbrain-local/frames [--sheet] [--dir folder] [--details]
editorbrain media search --query text [--provider all|wikimedia|nasa|loc|internet-archive] [--limit 10] [--licenses public-domain,cc0,cc-by] [--include-unknown] [--out .editorbrain-local/sources.json] [--dir folder] [--details]
editorbrain media preview --file source.mp4 --out .editorbrain-local/previews/review.mp4 [--quality 480|720|1080] [--audio-stream N]
```

## sfx

```text
editorbrain sfx index --input folder --bank ID [--dir folder]
editorbrain sfx search --project ID [query | --query text] [--bank ID] [--limit 6] [--scene-role hook|body|cta] [--local --dir folder --include-unverified]
editorbrain sfx get SOUND_ID --project ID --bank ID --catalog-sha256 HASH [--scene-role hook|body|cta] [--local --dir folder --include-unverified]
editorbrain sfx check --project ID --plan .editorbrain-local/sfx-plan.json [--remote --context-hash HASH] [--dir folder]
```

## motion

```text
editorbrain motion scenes [query | --query text] [--material motion|fotos|video] [--funcion id,id] [--encuadre id,id] [--tresD] [--scene-version <version>] [--limit 6] [--after cursor] [--facet-definitions]
editorbrain motion scene <scene-id> [--scene-version <version>]
editorbrain motion preview <scene-id> --scene-version <version> --ratio wide|square|tall [--preview-kind video|poster|first|last] [--preset <name>]
editorbrain motion source <scene-id> --scene-version <version> --out .editorbrain-local/scene.tar.gz [--dir folder]
editorbrain motion list [query]
editorbrain motion get <component-id> [--component-version 1.0.0]
editorbrain motion prepare --file scene.json --project ID --out .editorbrain-local/new-scene [--dir folder]
```

## production

```text
editorbrain production mix-events --voice voice.wav --cues cues.json --out .editorbrain-local/new-mix [--project ID --hook-end seconds --offline] [--dir folder]
editorbrain production review-sheet --file final.mp4 --out .editorbrain-local/new-sheet [--platform tiktok|reels|shorts] [--profile geometry.json] [--matte] [--dir folder]
editorbrain production matte-engines
editorbrain production matte-check --file montage.mp4 --mask-file mask.mp4 [--dir folder]
editorbrain production matte --engine apple-vision --file montage.mp4 --out .editorbrain-local/new-matte [--dir folder]
editorbrain production matte-plan --file montage.mp4 [--dir folder]
editorbrain production check --file render [--profile local-profile.json] [--dir folder] [--out .editorbrain-local/report.json] [--details]
editorbrain production delivery-check --project ID --file final.mp4 [--render-override exception.json] [--dir folder]
editorbrain production verify --project ID --file final.mp4 [--composition evidence.json] [--ocr] [--ocr-language eng] [--audio-profile audio.json] [--review-inputs continuity.json] [--platform tiktok|reels|shorts] [--profile geometry.json] [--duration seconds] [--at 0,5,12] [--dir folder] [--out .editorbrain-local/new-check] [--offline] [--details]
editorbrain production review-artifact --file review.json --out .editorbrain-local/review-v1.html [--media-mode local|embedded] [--context-file workflow.json] [--dir folder]
editorbrain production present --project ID [--file presentation.json | --id UUID] [--dir folder] [--url https://server]
editorbrain production withdraw --project ID --id UUID --expected-version HASH --user-confirmed [--url https://server]
editorbrain production review-open --file .editorbrain-local/review-v1.html [--port 0] [--dir folder]
editorbrain production reviews --project ID [--after UUID]
editorbrain production transcript --project ID --revision UUID
editorbrain production sample --project ID --file sample.json [--dir folder]
editorbrain production submit --project ID --file relative.mp4 --title TEXT [--parent UUID|latest] [--addresses TEXT | --revision-kind alternative|technical|continuation] [--notes TEXT] [--quality 480|720] [--dir folder]
editorbrain production approve --project ID --revision ID --context-version HASH --user-confirmed
editorbrain production change --project ID --revision ID --context-version HASH --text TEXT [--at start,end] [--kind cut|text|image|audio|pace|other] [--point x,y] [--parent-comment UUID] [--id UUID]
editorbrain production feedback --project ID [--revision ID] [--status pending|resolved] [--after UUID]
editorbrain production resolve-feedback --project ID --id UUID --file correction.json [--dir folder]
editorbrain production revoke-sample --project ID --revision ID
editorbrain production audio-check --file final.mp4 [--profile local-profile.json] [--dir folder] [--out .editorbrain-local/audio.json] [--details]
editorbrain production evidence-check --inventory local-inventory.json --manifest local-evidence.json [--dir folder] [--out .editorbrain-local/evidence.json] [--details]
editorbrain production motion-check --file local-motion-review.json [--dir folder] [--out .editorbrain-local/motion.json] [--details]
editorbrain production plan-check --inventory local-inventory.json --plan local-plan.json [--dir folder] [--out .editorbrain-local/report.json] [--details]
```

## preferences

```text
editorbrain preferences open --project ID [--out .editorbrain-local/preferences-NEW.html] [--dir folder] [--port N]
```

## direction

```text
editorbrain direction draft <project-id> --style pack-id [--assets tag,tag] [--capabilities tag,tag] [--duration seconds] [--out new-folder]
```

## assets

```text
editorbrain assets list [--limit 200] [--cursor opaque-cursor]
editorbrain assets upload <file> [--project ID] [--mime supported-media-type] [--purpose original|preview|final|temporary] [--source-sha256 hash]
editorbrain assets download <sha256> --out file
```

## storage

```text
editorbrain storage status
editorbrain storage cleanup --ids sha256,sha256 --confirm
editorbrain storage after-approval [--mode keep|ask|final-only] [--cloud-previews now|24h|7d] [--expected-revision N --user-confirmed]
editorbrain storage preview-cleanup --project ID --user-confirmed [--keep]
```

## keys

```text
editorbrain keys list
editorbrain keys create --label name [--role reader|editor|owner]
editorbrain keys revoke <key-id>
```
