Skip to main content

Command line reference

How to use​

You can run the CLI by installing @remotion/cli and running:

  • npx remotion inside a npm project
  • yarn remotion inside a Yarn project
  • pnpm exec remotion inside a pnpm project.
  • bunx remotion inside a Bun project

For brevity, in the documentation we always say npx remotion.

Inside an npm script, you don't need the npx prefix:

package.json
json
{
  "scripts": {
    "render": "remotion render"
  }
}
package.json
json
{
  "scripts": {
    "render": "remotion render"
  }
}

Using Bunv4.0.118​

By default, the npx remotion command is being executed using Node.
Even bunx remotion is using Node, unless you add the --bun flag.
To use Bun, replace remotion with remotionb.

package.json
json
{
  "scripts": {
    "render": "remotionb render"
  }
}
package.json
json
{
  "scripts": {
    "render": "remotionb render"
  }
}

Commands​

The following commands are available - you can always run them using npx remotion or even without the npx prefix if you put the command inside an npm script.

Example command​

npx remotion render --codec=vp8 HelloWorld out/video.webm
npx remotion render --codec=vp8 HelloWorld out/video.webm

Fig.io autocompletion​

Install Fig (macOS only) to add Remotion autocomplete to your terminal.
Type npx remotion to start getting suggestions.

See also​