Skip to content

Reference

CLI Commands

CommandPurpose
analyzeProbe video, sample frames, run vision analysis, and write analysis artifacts.
generateAnalyze if needed and write generated background music as a WAV.
renderGenerate music and mux or mix it into a video output.
evalEvaluate generated audio against a video and timeline.
vision-smokeRun a small frame-analysis smoke check.
music-smokeGenerate a short audio-only smoke sample.
sample-packCreate a review folder with style samples and optional renders.
magenta-setupDownload or prepare Magenta resources, model files, and bridge dependencies.
magenta-statusPrint detected bridge, resources, model, and runtime readiness.

See the CLI Guide for command examples, option groups, and the recommended run order.

Vision Providers

ProviderUse caseDefault API key behavior
openai-compatibleLM Studio, local gateways, vLLM, compatible proxiesNo key unless --vision-api-key-env is set
openaiHosted OpenAI-compatible APIUses OPENAI_API_KEY
anthropicAnthropic Messages APIUses ANTHROPIC_API_KEY

Hosted providers require an explicit --vision-model.

Common Options

OptionValues or defaultPurpose
--video PATHrequiredSource video file.
--prompt TEXTrequiredInitial music direction.
--frame-interval-seconds Ndefault: 5Sampling cadence for frame analysis.
--duration Ndefault: full videoLimit generation or render duration.
--workdir PATHcommand-specificArtifact output directory for manifests, frames, timelines, and reports.
--vision-provider NAMEopenai-compatible, openai, anthropicVision adapter to use.
--vision-base-url URLprovider defaultOpenAI-compatible gateway or provider root URL.
--vision-model MODELrequired for hosted providersVision model name.
--vision-profile PROFILEdefault: balanced; values: fast, balanced, qualityFrame-analysis prompt/detail profile.
--magenta-backend BACKENDdefault: auto; values: auto, bridge, cli, synthMusic backend selection.
--magenta-model MODELdefault: mrt2_small; values include mrt2_small, mrt2_baseMagenta model selection.
--magenta-runtime RUNTIMEdefault: mlx; values: mlx, jaxMagenta runtime selection.
--prompt-update-mode MODEvalues: continuous, segment-stitchPrompt update semantics.
--audio-mode MODEvalues: replace, mixRender behavior.
--music-volume-db DBdefault: -3Gain applied to generated music in mix mode.
--original-volume-db DBdefault: -18Gain applied to source audio in mix mode.

Output Artifacts

ArtifactPurpose
analysis.jsonStructured frame observations.
timeline.jsonTime-aligned prompt timeline and weighted prompt slots.
frames_manifest.jsonRequested and actual frame extraction metadata.
contact_sheet.jpgVisual frame summary.
segments.csvSegment-level prompt and timing data.
eval.mdHuman-readable evaluation report when generated.
music.wavGenerated 48 kHz stereo music.
rendered-video.movRendered video output when using render.

Secrets

Do not store API keys in manifests or docs. Use environment variables:

  • OPENAI_API_KEY for hosted OpenAI-compatible vision calls
  • ANTHROPIC_API_KEY for Anthropic vision calls
  • a custom variable named by --vision-api-key-env for gateways or proxies

Rust CLI and Tauri desktop docs for adaptive video background music generation.