Videobrew CLI

This package contains only the CLI for Videobrew. Come check out the main repository for more information.

📼 Videobrew

Create videos using any web technologies (like Svelte, Vue and React) or just plain old HTML, CSS and Javascript. Animate your web page and have Videobrew render it to a video.

---

🚧 Work in progress

This project is a work in progress. If you have any questions, please open an issue.

---

🚀 Quickstart

Start composing your videos with code!

---

Install the CLI

$ npm i -g @videobrew/cli

---

Create your video app

Let's build the webpack example Video App:

$ cd examples/webpack
$ npm run build

The webpack example video app is built to dist/

---

Preview your video

See your video app in action by letting Videobrew know where it is:

$ videobrew preview dist/

Open the editor in your browser @ http://localhost:8087

---

Render your video

$ videobrew render dist/ my-video.mp4

---

Done 🎉

Watch 📼 the video that Videobrew rendered

---

Next Steps

Check out the 🧪 Example Video Apps to see how your favorite web technologies work with Videobrew.

Read the 📖 Documentation to learn how Videobrew works and how to start coding your own video

---

🧪 Example Video Apps

Example	Description	Uses @videobrew/client
Zero Dependencies	Just plain old HTML, CSS and Javascript.
Local Installation	Shows how to install and use Videobrew with --save-dev instead of globally with -g.
Sveltekit (wip)	A Sveltekit video app example.	✔
Webpack + TypeScript	Use Webpack and TypeScript to make your video app.	✔

---

😍 Special Thanks

Videobrew wouldn't be here without these awesome projects: Playwright, FFmpeg, Chalk, Prompts, TypeScript, TailwindCSS, Vite, Svelte and more!

---

License

Videobrew - Create videos using any web technologies.

Copyright (C) 2023 Luttje

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

A copy of the GNU Affero General Public License can be found here. The full license text can also be found on https://www.gnu.org/licenses/.

Third Party Licenses

Licenses of third parties we are directly depending on can be found here. This file was automatically generated with license-checker-rseidelsohn upon running npm run build.