Back to Remotion

Creating a new project

packages/docs/docs/getting-started.mdx

4.0.4633.0 KB
Original Source

Coding Agent Prompt

Paste into a coding agent, such as Claude Code, Codex or OpenCode:

Ensure Node.js is installed.
Install Remotion Skills: npx -y skills@latest add remotion-dev/skills -g -y
Then use them to create a video.

From the command line

sh
npx create-video@latest --yes --blank my-video
cd my-video
npm i
npx remotion skills add
npm run dev

Creates a video in the my-video directory, with TailwindCSS, blank template and Agent Skills.

Planning to prompt a video using a coding agent?
Click here for more detailed beginner instructions.

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Wizard

Customize the creation of a Remotion project by selecting a specific template, enable or disable Tailwind and Agent Skills.

<Tabs defaultValue="npm" values={[ { label: 'npm', value: 'npm', }, { label: 'bun', value: 'bun', }, { label: 'pnpm', value: 'pnpm', }, { label: 'yarn', value: 'yarn', }, ] }> <TabItem value="npm">

bash
npx create-video@latest
</TabItem> <TabItem value="pnpm">
bash
pnpm create video
</TabItem> <TabItem value="yarn">
bash
yarn create video
</TabItem> <TabItem value="bun">
bash
bun create video

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

</TabItem> </Tabs>

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

<Tabs defaultValue="npm" values={[ { label: 'Regular templates', value: 'npm', }, { label: 'Next.js + React Router 7', value: 'pnpm', }, ] }> <TabItem value="npm">

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

bash
npm run dev
</TabItem> <TabItem value="pnpm">

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

bash
npm run dev

To start the Remotion Studio:

bash
npm run remotion
</TabItem> </Tabs>

System requirements

To use Remotion, you need at least Node <MinNodeVersion /> or Bun <MinBunVersion />. šŸŽ macOS 15 (Sequoia) or later is required. Older versions are not supported.
🐧 Linux distros need at least version 2.35 of Libc.
They also need to install some additional packages.
Alpine Linux and nixOS are unsupported.

Installation in existing projects

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