Usage
CLI commands
Section titled “CLI commands”creator-studio-os serve # Start the MCP server (used by your MCP client)creator-studio-os verify # Check your setupcreator-studio-os smoke # Run the 9-phase smoke harnesscreator-studio-os protocol run <name> --project <path>creator-studio-os protocol listcreator-studio-os protocol describe <name>creator-studio-os --helpRunning a protocol
Section titled “Running a protocol”The flagship pipeline is brand-deck-minimal — a 13-step cross-app protocol that takes a project.json spec and produces a ProRes MOV:
creator-studio-os protocol run brand-deck-minimal \ --project demo/csos-showcase/project.jsonOutput streams step-by-step:
✓ 1/13 validate-project✓ 2/13 compose-brand-cards✓ 3/13 render-scene-clips...✓ 13/13 write-replay-manifestSee Protocols for the full brand-deck-minimal walkthrough.
Using tools from Claude
Section titled “Using tools from Claude”With the MCP server running, Claude can call any of the 153 tools directly. Examples:
Build and import an FCPXML timeline:
Build an FCPXML timeline for my project at creator-studio/projects/my-project/project.jsonand import it into Final Cut Pro.Check app health:
Run csos_app_status to see which apps are open.Render a Motion template:
Clone the Atmospheric lower-third template to /tmp/my-lower-third.motn,set the title to "Chapter One", and render it to ProRes 4444.project.json format
Section titled “project.json format”Protocols operate on a project.json file in the ProjectV2 schema:
{ "name": "my-project", "scenes": [ { "id": "intro", "title": "Introduction", "subhead": "What we cover" } ], "brand": { "primaryColor": "#1a1a2e", "accentColor": "#e94560" }, "deliverables": { "format": "ProRes", "resolution": "1920x1080", "frameRate": 24 }}Full schema lives in @creator-studio-os/core. Demo: demo/csos-showcase/project.json in the source repo.
Logging levels
Section titled “Logging levels”| Flag | Output |
|---|---|
| (none) | Normal: step results, errors |
--verbose | Tool calls, timing, intermediate state |
--debug | Full stack traces, raw AppleScript output |
--silent | Errors only |
Secrets are never logged at any level.
Smoke harness
Section titled “Smoke harness”The 9-phase smoke suite runs integration tests against the real apps:
npm run smoke:ciPhases: app health → Compressor encode → Motion clone+render → FCP round-trip diff → ledger → tool-compass discoverability (12 semantic queries) → protocol real-render with movEyeballGate.
CI runs typecheck + build + unit tests on Linux for all 10 packages. The smoke harness runs locally on macOS — macOS GitHub Actions runners cost roughly 10× Linux per CI minute, so the integration tests stay on the dev machine.
Coverage
Section titled “Coverage”Every package in the workspace clears a 75% line / 75% branch floor. Total workspace coverage as of v2.0.0:
- 1173 unit tests
- All 9 publishable packages above floor
- Per-package coverage tracked on Codecov with carryforward flags