The CLI tool for generating CodeVideos.
- Clone this repository:
git clone https://github.com/codevideo/codevideo-cli- Rename the
.env.examplefile to.envand fill in the required fields:
cp .env.example .envIf you don't have an Elevenlabs account - we're working on a solution with htgo-tts and other providers.
- Try a simple example video generation:
go run main.go -p "[{\"name\":\"author-speak-before\",\"value\":\"Let's learn how to use the print function in Python!\"},{\"name\":\"author-speak-before\",\"value\":\"First, let's make a Python file.\"},{\"name\":\"file-explorer-create-file\",\"value\":\"main.py\"},{\"name\":\"file-explorer-open-file\",\"value\":\"main.py\"},{\"name\":\"author-speak-before\",\"value\":\"and let's print 'Hello world!' to the console.\"},{\"name\":\"editor-type\",\"value\":\"print('Hello, world!')\"}]"Note: if you are using zsh and get the error zsh: event not found: \, try deactivating history expansion with set +o histexpand and try the command again.
If all works well, you should see the following final output:
Detected project type: Actions
/> CodeVideo generation in progress...
[==========================] 100%
✅ CodeVideo successfully generated and saved to CodeVideo-2025-03-21-18-58-47.mp4Alternatively build the prod version and run it:
go build -o codevideo
./codevideo -p "[{\"name\":\"author-speak-before\",\"value\":\"Let's learn how to use the print function in Python!\"},{\"name\":\"author-speak-before\",\"value\":\"First, let's make a Python file.\"},{\"name\":\"file-explorer-create-file\",\"value\":\"main.py\"},{\"name\":\"file-explorer-open-file\",\"value\":\"main.py\"},{\"name\":\"author-speak-before\",\"value\":\"and let's print 'Hello world!' to the console.\"},{\"name\":\"editor-type\",\"value\":\"print('Hello, world!')\"}]"As yet another alternative, paste your actions into actions.json and run the following command:
./codevideo -p "$(cat actions.json)"Simply pass the -m serve parameter to the command to start the server:
go build -o codevideo
./codevideo -m serveTo run in the background use nohup or similar:
nohup ./codevideo -m serve &Build the container
docker build -t codevideo .Run in server mode (default)
docker run -p 8080:8080 -v $(pwd)/.env:/.env -v $(pwd)/output:/app/output codevideodocker run -v $(pwd)/.env:/.env -v $(pwd)/output:/app/output codevideo -p "[{\"name\":\"author-speak-before\",\"value\":\"Let's learn how to use the print function in Python!\"}]"You can update the Gatsby static site by replacing the public folder within cli/staticserver. We recommend you use the example site within the example folder of the @fullstackcraftllc/codevideo-ide-react repository.
Everything in the public folder is treated as an embedded go resource and served by the server.
Build your actions JSON in the CodeVideo Studio!