Reading the repo
Reading the repo
How to install on Linux
Explainer videos and product demos made by your AI agent. Free and open source: a local voice (Kokoro), word timing (Whisper) and a canvas renderer turn a script into a narrated MP4.
Fresh setup, read just now
Will it work on Linux?
Then run bash setup.sh. It stops at the first error and is safe to run again. Servers and tests aren't started; it lists them at the end. Read it first.
git clone https://github.com/vincentsch/explainroo.git cd explainroo
Node.js >=20.11
# needs nvm: https://github.com/nvm-sh/nvm nvm install --lts
npm ci
npm test
You need Node.js 20.11 or newer, ffmpeg, and Chrome or Chromium. The first setup downloads the voice and timing models once, about 400 MB together. You don't need a graphics card. I develop explainroo on Linux, and its tests run on Linux, macOS and Windows for every change.
git clone https://github.com/vincentsch/explainroo.git
cd explainroo
npm install
node bin/explainroo.js doctor --fetch
For narration in Spanish, French, Italian, Portuguese or Hindi, also install
espeak-ng, for example with
sudo apt install espeak-ng or brew install espeak-ng. Japanese and
Chinese need Python with misaki instead,
as described in AGENTS.md.
Then start your agent in the explainroo folder and ask for a video, for
example "Make a 60 second video about how HTTPS keeps a password secret." The
agent follows AGENTS.md and saves the video as
videos/<name>/out/video.mp4. The example videos are in
examples/, and the full documentation is on
explainroo.com.
No reports for Linux yet.
Opens a chat with this manual already filled in, for Linux. It uses your own account; gitmanual sends nothing.