ContextQMD
Back to Remotion

npx create-video

packages/docs/docs/cli/create-video.mdx

4.0.4782.3 KB
Original Source

import {CreateVideoTemplateFlags} from '../../components/CreateVideoTemplateFlags';

Scaffold a new Remotion project.

bash
npx create-video <directory>

If no arguments are passed, an interactive TUI will guide you through the setup.

Arguments

<directory>

The directory in which the project should be created.

Flags

--yes<AvailableFrom v="4.0.439" />

Enable non-interactive mode. All prompts are skipped with sensible defaults.

Requires a template flag and a directory argument.

When used:

  • TailwindCSS is installed if the template supports it (disable with --no-tailwind)
  • Agent skills are not installed
  • The editor is not opened
  • If already inside a Git repository, the command fails
bash
npx create-video --yes --blank my-video

-y<AvailableFrom v="4.0.439" />

Alias for --yes.

--no-tailwind<AvailableFrom v="4.0.439" />

When combined with --yes, skip installing TailwindCSS. Without --yes, this flag has no effect because TailwindCSS is offered interactively.

bash
npx create-video --yes --blank --no-tailwind my-video

--tmp<AvailableFrom v="4.0.214" />

Create the project in a temporary directory instead of specifying a directory name.

bash
npx create-video --yes --blank --tmp

Template flags

Pass a template name as a flag to skip the template selection prompt.

bash
npx create-video --blank my-video

Available templates: <CreateVideoTemplateFlags />.

Non-interactive mode

By passing --yes (or -y), all prompts are skipped and the project is created with sensible defaults. This is useful for scripting and AI agents like Claude Code.

A template flag and a directory argument are required.

bash
npx create-video --yes --blank my-video

When using --yes:

  • TailwindCSS is installed if the template supports it. Pass --no-tailwind to skip it.
  • Agent skills are not installed. You can add them manually afterwards by running npx skills add remotion-dev/skills in the project directory.
  • The editor is not opened after scaffolding.
  • The command fails if you are already inside a Git repository.

Examples

Without TailwindCSS:

bash
npx create-video --yes --blank --no-tailwind my-video

In a temporary directory:

bash
npx create-video --yes --blank --tmp