CLI Wizard (vid2ssq)
The fastest way to transform any video into a production-ready Scrollsequence project is using the interactive CLI wizard:
npx scrollsequence vid2ssqNo flags needed — the wizard interactively guides you through:
- Source Selection: Pick a local video file (
.mp4,.mov,.webm) or a directory of frames. - Project Destination: Choose a project name (automatically routes to
public/<name>if run in Next.js, Vite, or Astro). - Format Selection:
jpg(fastest hardware decoding) orwebp(with alpha transparency support). - Compression & Sizing: Set image quality, frame step rate, and responsive width tiers (e.g.
1280,1920). - AI Features: Optionally generate 3D depth maps, bounding tracking, and vision scene understanding.
Zero Configuration in Next.js & Vite: When run inside a directory containing ./public, the CLI automatically writes generated frames and the manifest to public/<project-name>, making them immediately accessible via your local dev server.
Non-Interactive & CI/CD Usage
You can automate asset generation in build scripts or CI pipelines by passing arguments directly:
# Standard local processing (100% free, local FFmpeg via WebAssembly)
npx scrollsequence vid2ssq input.mp4 --name hero-sequence --sizes 1280,1920 --format jpg --quality 80
# Advanced AI processing with 3D Depth Maps & Subject Tracking (Requires API Key)
npx scrollsequence vid2ssq input.mp4 --name car-reveal --sizes 1280,1920 --depth --track "sports car"CLI Options Reference
| Option | Flag | Description | Default |
|---|---|---|---|
[input] | Argument | Path to input video (.mp4, .mov, .webm) or image directory. | Prompted |
--name | -n | Output project name (routes to public/<name> if public/ exists). | scrollsequence-project |
--sizes | Comma-separated target widths in pixels. | 1280,1920 | |
--format | Image format: jpg (fastest decoding) or webp (supports alpha). | jpg | |
--quality | Image quality between 1 and 100. | 80 | |
--step | -s | Process every Nth frame (e.g. 2 skips every other frame). | 1 |
--depth | Generate 3D depth maps for WebGL displacement effects (Requires API key). | false | |
--depth-width | Resolution width for depth map sequence in pixels. | 720 | |
--track | -p | Text prompt for AI subject tracking across frames (Requires API key). | undefined |
--vision | -v | Run AI vision motion & scene understanding analysis (Requires API key). | false |
--zip | Package generated assets into a .zip archive upon completion. | false |
Last updated on