Skip to content

Latest commit

 

History

History
56 lines (49 loc) · 5.77 KB

CLI.md

File metadata and controls

56 lines (49 loc) · 5.77 KB

CLI reference

Run python -S studio.py --help for the complete parser and subcommand help.

Command Purpose
setup [--with-library] Check prerequisites and install pinned Node dependencies; optionally restore the full source library
skills plan --mode video|website|ui-motion Read-only selection of relevant pinned instructions and actual missing paths
skills setup --mode MODE Fetch only the selected source repositories; never run their code or install runtimes
skills check --mode MODE Offline source integrity check, including manifest-based full bundles
doctor Offline readiness and version checks; nonzero exit when required render dependencies are missing
demo [--format 9:16] [--render] New synthetic editable HyperFrames example
new TITLE --kind KIND --duration SECONDS Create a job; no generation
map / route KIND / find QUERY Select production guidance
resume JOB Show the earliest incomplete stage
check JOB --stage STAGE Evidence checks for brief/research/storyboard/assets/preview/final
asset-add JOB --file FILE --source SOURCE --rights RIGHTS --purpose PURPOSE Copy and hash an asset
render-html JOB --name NAME Lint, render with HyperFrames and probe
walk-talk prepare JOB --mode footage|recording|ai Create editable walking-presenter shot, text and sound plans without provider calls
director plan JOB --profile explainer|demo|launch Compute editable beat-sheet JSON/Markdown from a validated storyboard
director qa JOB --profile PROFILE Editorial storyboard warnings only; does not inspect MP4 or sound
director handoff JOB --profile PROFILE Generate Explainroo/Argo/OM editorial project scaffolds under source/interchange
director captions JOB --alignment source/alignment.json Convert real aligned word timestamps into scene cues and UTF-8 SRT
director feedback JOB --at SEC --x 0..1 --y 0..1 --comment TEXT Queue location-specific feedback against scene/time; no automatic edit
director feedback-list JOB Read queued feedback
walk-talk compose JOB Compose registered full-length footage, optional aligned alpha foreground, timed captions and hero words into HyperFrames sources
render-hype JOB --scene source/index.hype --name NAME Validate and render with the installed Hypermotion desktop/CLI, record provenance and probe
kinetic setup --source PATH / doctor Verify and cache the separately obtained pinned Kinetic Film package; inspect optional local dependencies
kinetic prepare JOB [--example social-motion-agent] Create source/kinetic/spec.js and an adapted job-local runtime without overwriting a composition
kinetic demo [--render] [--res 720] [--samples 2] New job reproducing the owner's current README film with supplied audio
render-kinetic JOB --name NAME --res 1080 --samples 4 [--audio ASSET_ID] Render Kinetic Film, enforce motion gates, record matching source/render receipt and probe
render-assembly JOB Assemble registered footage/stills with FFmpeg
edit JOB fx --asset ID --name NAME --effect SPEC Apply local FFmpeg effects
probe JOB --render PATH Check dimensions, duration, FPS and audio
sheet JOB --render PATH Generate a contact sheet
pack JOB Create delivery only when evidence passes
background IMAGE OUTPUT --duration SECONDS Animate an image into a clip
sfx build/find/check Index and search your own licensed audio
motion find/show/recipe Extended catalogue, fetched as a pinned source or expanded in a full bundle
motion presets [SLUG] 13 built-in seekable canvas styles shared with examples/motion-styles
motion lint FILE.html Static film-not-slides check: Math.random/system clock, seek contract, opacity-switched section decks, kicker+title+body scenes, autoplay video, CSS clocks, will-change; exit 1 on errors
directions list [MENU] / show SLUG / brief --for TEXT [--kind opener|explainer] [--previous FP] / compare FP1 FP2 Motion direction menus (10 styles, 19 opener concepts, 6 explainer modes, background motion, surfaces, render families, transitions, openings, endings), style-brief skeleton and structure-fingerprint novelty check
styles list/recipe/find/show 14 styles: 12 canonical Opus 5.5 styles plus isometric-line-art and flat-vector explainers; upstream prompt search and deterministic scene blueprints
unslop-story OUTPUT [--title TITLE] [--ramp graphite|warm|ink] Generate a deterministic 4-pass Before->After Redline Transformation Story HTML (window.seek(t))
polish HTML Optional Playwright layout measurements and 4-pass Unslop DOM checks

JOB must be inside output/jobs. --render paths are relative to that job. Paid narration is separate: python -S scripts/voiceover.py --help.

Optional video-studio edit operations require VSTUDIO_SCRIPT. Optional browser measurements require Playwright and its Chromium installation; upstream heuristic gates require their separate source installation. No optional dependency is reported as connected just because its instructions exist.

First run

Run python -S studio.py setup, then python -S studio.py demo --render. Setup uses npm ci --ignore-scripts inside this repository. Python 3.11+, Node 22+ with npm, FFmpeg and ffprobe must already be installed; missing prerequisites produce actionable diagnostics and a nonzero exit. Git is needed only when restoring the optional source library with --with-library.

doctor checks local executables, versions, required skill paths and the bundled Node runtime dependencies without reading credentials or contacting external accounts. Its JSON report includes ready, prerequisites_ready, issues and next_steps. Read ready or the process exit code before attempting a render. Browser download availability and paid provider accounts are not checked.