Skip to main content

Command line reference

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.

npx remotion preview

Start the server which allows you to preview the Remotion video. The only argument to pass is the entry file:

bash
npx remotion preview src/index.tsx
bash
npx remotion preview src/index.tsx

npx remotion render

Render a video based on the entry point, the composition ID and save it to the output location.

bash
npx remotion render <entry-file> <composition-id> <output-location>
bash
npx remotion render <entry-file> <composition-id> <output-location>

npx remotion still

Available from v2.3.

Render a still frame basd on the entry point, the composition ID and save it to the output location.

bash
npx remotion still <entry-file> <composition-id> <output-location>
bash
npx remotion still <entry-file> <composition-id> <output-location>

npx remotion upgrade

Upgrade all Remotion-related dependencies to the newest version.

npx remotion --help

Prints the list of commands and flags for quick lookup.

Flags

Besides choosing a video and output location with the command line arguments, the following flags are supported:

--props

available for preview, render, still commands

React Props to pass to the root component of your video. Must be a serialized JSON string (--props='{"hello": "world"}') or a path to a JSON file (./path/to/props.json).

info

Inline JSON string isn't supported on Windows because it removes the " character, use a temporary file instead.

--concurrency

available for render command

How many CPU threads to use. Minimum 1. The maximum is the amount of threads you have (In Node.JS os.cpus().length).

--pixel-format

available for render command

Set a custom pixel format. See here for available values.

--image-format

available for render, still commands

jpeg or png - JPEG is faster, but doesn't support transparency. The default image format is jpeg since v1.1. Flag available since v1.4.

--config

available for preview, render, still commands

Specify a location for the Remotion config file. Available in v1.2 and later.

--env-file

available for preview, render, still commands

Specify a location for a dotenv file. Default .env. Available in v2.2 and later.

--quality

available for render, still commands

Value between 0 and 100 for JPEG rendering quality. Doesn't work when PNG frames are rendered. Available since v1.4.

--overwrite

available for render, still commands

Write to output even if file already exists.

--sequence

available for render command

Pass this flag if you want an image sequence as the output instead of a video. Available since v1.4.

--codec

available for render command

h264 or h265 or png or vp8 or vp9 or mp3 or aac or wav or prores or h264-mkv. If you don't supply --codec, it will use the H.264 encoder. Available since v1.4.

--prores-profile

available for render command

Set the ProRes profile. This option is only valid if the codec has been set to prores. Possible values: 4444-xq, 4444, hq, standard, light, proxy. See here for explanation of possible values. Default: hq. Available since v2.1.6.

--crf

available for render command

To set Constant Rate Factor (CRF) of the output. Minimum 0. Use this rate control mode if you want to keep the best quality and care less about the file size. Available since v1.4.

--browser-executable

available for still, render commands

Path to a Chrome executable. If not specified and Remotion cannot find one, it will download one during rendering. Available since v1.5.

--frames

available for render command

Render a still frame or a subset of a video. Example: --frames=0-9 (To select the first 10 frames) or --frames=50 (To render a still of the 51st frame). Available since v2.0.

--frame

available for still command

Which frame should be rendered when rendering a still. Example --frame=10. Default 0. Available from v2.3

--bundle-cache

available for still, render commands

Enable or disable Webpack caching. This flag is enabled by default, use --bundle-cache=false to disable caching. Available since v2.0.

--log

available for preview, still, render commands

Set the log level. Increase or decrease the amount of output. Acceptable values: error, warn, info (default), verbose

info

If you don't feel like passing command line flags every time, consider creating a remotion.config.ts config file.

--port

available for preview, still, render commands

Set a custom HTTP server port. If not defined, Remotion will try to find a free port.

--ffmpeg-executable

available for render command

Set a custom FFMPEG executable. If not defined, a ffmpeg executable will be searched in PATH.

--help

Print the list of available CLI commands and flags.

Example command

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

Fig.io autocompletion

Fig adds visual apps, shortcuts, and autocomplete to your existing Terminal. The remotion autocompletion is available on Fig, try i with npx remotion, remotion, yarn create video. Useful if you have a memory lapse.

See also