CLI Docs | Brainy Canvas

The CLI wraps the Brainy Canvas API in direct terminal commands. It is useful for local automation, demos, scripts, and quick workflow runs.

Installable package

Install @brainycanvas/cli from npm and run commands through the brainy binary.

Direct commands

Create projects, add nodes, connect nodes, run workflows, and inspect results without writing curl requests.

Same canvas engine

The CLI calls the same secure API routes used by agents and custom integrations.

Install

npm install -g @brainycanvas/cli
brainy --help

Sign in

Sign in to Brainy Canvas.
Open the account menu and choose API keys.
Create a key for your terminal.
Save it with the CLI.

brainy login --key bc_live_...

# For local development:
brainy login --key bc_live_... --base-url http://localhost:3001

Create and run a workflow

brainy projects create "Launch storyboard"
brainy nodes add PROJECT_ID text --text "Draft a product launch storyboard"
brainy nodes add PROJECT_ID chat --model gpt-4o-mini
brainy connect PROJECT_ID TEXT_NODE_ID CHAT_NODE_ID
brainy run PROJECT_ID
brainy runs watch RUN_ID

Generate durable media

Media commands use the asynchronous generation API. Model discovery is read-only; create, edit, and animate commands reserve credits before work is queued. Always supply an idempotency key from automation.

brainy media models --kind image

brainy media generate \
  --kind image \
  --preset campaign-image \
  --prompt "A premium studio photo of a cobalt travel bottle" \
  --aspect-ratio 4:5 \
  --idempotency-key fall-launch-hero-v1

brainy media watch GENERATION_ID

For edits and animation, pass an input array as JSON. Upload private source files through the REST upload endpoint first.

brainy media edit \
  --preset localized-image \
  --prompt "Translate the headline and CTA" \
  --aspect-ratio 1:1 \
  --inputs '[{"url":"UPLOAD_URL","mimeType":"image/png","role":"sourceCreative"}]' \
  --parameters '{"targetLocale":"fr-CA","preserveLayout":true}' \
  --idempotency-key localized-fr-ca-v1

Useful commands

brainy node-types lists available node types.
brainy projects list lists your projects.
brainy projects get PROJECT_ID reads a canvas.
brainy nodes list PROJECT_ID lists nodes.
brainy output PROJECT_ID reads workflow output.
brainy projects list --json prints JSON for scripting.
brainy media get GENERATION_ID reads status and outputs.

API keys remain available for direct REST calls. Agent apps should use the browser sign-in flow instead.

Brainy Canvas CLI