Creating a new project

Prerequisites

To use Remotion, you need at least Node 16 or Bun 1.0.3.

Scaffolding a new project

You can initialize a new Remotion video using

npm

bash
npx create-video@latest

bash
npx create-video@latest

bun

bash
pnpm create video

bash
pnpm create video

pnpm

bash
yarn create video

bash
yarn create video

yarn

bash
bun create video

bash
bun create video

note

Bun as a runtime is mostly supported. Read more here.

Choose the template that is most suitable for you. For your first project, we recommend the Hello World template.

After the project has been scaffolded, we recommend to open the project in your text editor and starting the Remotion Studio:

bash
npm start

bash
npm start

Additional information for Linux users

Linux users need to install some additional packages to get Chrome/Puppeteer working correctly.

Arch Linux

bash
pacman -S dconf alsa-lib atk glibc cairo libcups dbus expat fontconfig gcc gdk-pixbuf2 glib2 gtk3 nspr pango gcc-libs libx11 libxcomposite libxcursor libxdamage libxext libxfixes libxi libxrandr libxrender libxss libxtst ca-certificates ttf-liberation libappindicator-gtk3 nss lsb-release xdg-utils wget mesa

bash
pacman -S dconf alsa-lib atk glibc cairo libcups dbus expat fontconfig gcc gdk-pixbuf2 glib2 gtk3 nspr pango gcc-libs libx11 libxcomposite libxcursor libxdamage libxext libxfixes libxi libxrandr libxrender libxss libxtst ca-certificates ttf-liberation libappindicator-gtk3 nss lsb-release xdg-utils wget mesa

Ubuntu and Debian

bash
apt install gconf-service libasound2 libatk1.0-0 libc6 libcairo2 libcups2 libdbus-1-3 libexpat1 libfontconfig1 libgcc1 libgconf-2-4 libgdk-pixbuf2.0-0 libglib2.0-0 libgtk-3-0 libnspr4 libpango-1.0-0 libpangocairo-1.0-0 libstdc++6 libx11-6 libx11-xcb1 libxcb1 libxcomposite1 libxcursor1 libxdamage1 libxext6 libxfixes3 libxi6 libxrandr2 libxrender1 libxss1 libxtst6 ca-certificates fonts-liberation libnss3 lsb-release xdg-utils wget libgbm-dev

bash
apt install gconf-service libasound2 libatk1.0-0 libc6 libcairo2 libcups2 libdbus-1-3 libexpat1 libfontconfig1 libgcc1 libgconf-2-4 libgdk-pixbuf2.0-0 libglib2.0-0 libgtk-3-0 libnspr4 libpango-1.0-0 libpangocairo-1.0-0 libstdc++6 libx11-6 libx11-xcb1 libxcb1 libxcomposite1 libxcursor1 libxdamage1 libxext6 libxfixes3 libxi6 libxrandr2 libxrender1 libxss1 libxtst6 ca-certificates fonts-liberation libnss3 lsb-release xdg-utils wget libgbm-dev

note

Watch out for apt wanting to uninstall critical packages (e.g the Desktop) in order to install the Remotion dependencies. Abort the installation and seek help in our Discord if that happens!

Linux distros that use libc need at least version 2.31 of it. Check here if your distro has it.

Got instructions for more Linux distributions? Add them to this page!

Installation in existing projects

Want to install Remotion in an existing project? Go here instead: Installation in existing projects