Commands

How do I run a command?

In the explainroo folder, run node bin/explainroo.js <command>. After npm link you can type explainroo <command> instead. Most commands take the project folder as their first argument. If you leave it out, they use the current folder. Every command takes --json when a program needs to read the output.

Which commands make a video?

Command	What it does
init <dir>	creates a new project with a starter script and scenes. The options are --theme, --size, --pace, --voice and --title
voice [project]	makes the voice recording and the word times. It lists the words the speech check could not confirm. It only redoes scenes that changed. --force redoes all of them
preview [project]	opens a live preview in your browser that reloads when you save. --port sets the port, which is 4400 by default
still [project] [times]	saves PNG pictures of single moments. A time looks like 12.5, scene, scene@2.4, scene@start or scene@end. Without times, it saves the end of every scene
sheet [project]	saves a contact sheet. --scene <id> makes one for a single scene. --every <seconds> sets the time between the frames and --cols <n> the number of columns
check [project]	finds problems with layout, timing and pronunciation. When it finds errors, it ends with an error code
render [project]	saves the video as out/video.mp4. --draft makes a quick half-size out/draft.mp4. --from and --to render only part of the video, in seconds. --workers sets how many Chrome pages draw at the same time. --out sets the file
verify [project]	checks the finished MP4 for loudness, peaks, black frames, silence and a clear voice. --file checks a different file

Which commands help with images?

Command	What it does
image [project] <name> "<prompt>"	makes an AI illustration through OpenRouter and saves it as assets/<name>.png. The options are --model best or --model cheap, --aspect, --ref and --no-style
images [project]	lists the images made for the project and what they cost

Which commands help me look things up?

Command	What it does
voices	lists the 28 voices
say "text"	saves a short recording of a voice saying your text. The options are --voice, --speed and --out
themes	lists the five looks and the music styles
formats	lists the sizes for YouTube, Shorts, TikTok, Reels, Instagram and LinkedIn
icons <word>	searches the 1,854 icons by name and tag
doctor	checks that Node, ffmpeg, Chrome and the speech models are there. --fetch downloads the models