brandreel-cli
v0.3.0
Published
CLI for BrandReel — inspect brand workspaces and generate on-brand images and video clips.
Maintainers
Readme
BrandReel CLI
Use BrandReel’s brand workspaces and generation pipeline from agents, scripts, and the terminal. Generation runs on Runware models behind the BrandReel API, with the same plan limits and monthly credits as the web app.
npx skills add thijssmudde/brandreel-cli
npm install -g brandreel-cli
export BRANDREEL_API_KEY=br_your_key
br brands:listCreate or rotate your key in BrandReel account settings.
Pick a brand once
br brands:create "VerifiedDR" --website verifieddr.com --colors "#0a84ff,#0b1220" --logo ./logo.png --use
br brands:use verifieddr # writes ./.brandreel.json
br brands:use verifieddr --global # writes ~/.brandreel/config.json
br brands:currentBrand context resolves in this order: --brand <slug>, a positional slug,
BRANDREEL_BRAND, the nearest .brandreel.json walking up from the working
directory, then the global config. Every brand-scoped command can then omit the
slug.
Generate
br models:list
br assets:list
br assets:upload ./product.png
br assets:upload ./logo.png --kind logo
br image:create --prompt "Editorial product still, cobalt paper, crisp side light" \
--source-image ./product.png --aspect-ratio 4:3 --image-size 2K \
--brand-colors --out ./public/hero.png
br video:create --prompt "Slow dolly in, soft reflections" \
--source-image ./public/hero.png --duration 5 --resolution 720p --out ./public/hero.mp4
br generation:get <generation-id> --out ./public/hero.png
br generations:list --limit 20
br media:download <url|generation-id> ./public/hero.png--source-image accepts a URL or a local file; local files are uploaded to the
brand asset library first and the returned URL is used as the reference. Repeat
the flag for multiple references.
Image and video commands wait for the job to finish and print the final media
URL. Pass --no-wait to return immediately, --timeout <seconds> to bound the
wait (default 300 for images, 1200 for video), and --out <file> to write the
result to disk.
Budget
br usage # tier, credit limit, used, remaining
br budget:set --max-credits 40 # default cap for this project
br image:create --prompt "..." --max-credits 12--max-credits is enforced by the API: a run that would cost more is refused
with exit code 7 before any credits are reserved. br budget:set stores the cap
in .brandreel.json (or ~/.brandreel/config.json with --global) and applies
it to every later generation.
Output
Successful output is JSON on stdout. Exit codes: 2 usage error, 3 missing key, 4 network failure, 5 generation failed or timed out, 6 API error, 7 over budget.
Agent flows should run assets:list before generating. It returns fresh usable
URLs for the workspace logo and asset library. See
API docs and
agent playbooks.
License
MIT
