Skip to main content

npx remotion render

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

bash
npx remotion render <entry-point|serve-url>? <composition-id> <output-location>

You may pass a Serve URL or an entry point as the first argument, otherwise the entry point will be determined.

If composition-id is not passed, Remotion will ask you to select a composition.
If output-location is not passed, the media will be rendered into the out folder.

Flags​

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

--props​

Input Props to pass to the selected composition of your video..
Must be a serialized JSON string (--props='{"hello": "world"}') or a path to a JSON file (./path/to/props.json).
From the root component the props can be read using getInputProps().
You may transform input props using calculateMetadata().

note

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

--heightv3.2.40​

Overrides composition height.

--widthv3.2.40​

Overrides composition width.

--concurrency​

How many CPU threads to use. Minimum 1. The maximum is the amount of threads you have (In Node.JS os.cpus().length). You can also provide a percentage value (e.g. 50%).

--pixel-format​

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

--image-formatv1.4.0​

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

--image-sequence-pattern v4.0.313​

[Pattern for naming image sequence files. Supports [frame] for the zero-padded frame number and [ext] for the file extension.]

Example:

bash
npx remotion render ... --sequence --image-sequence-pattern='frame_[frame]_custom.[ext]'
# Produces: frame_0001_custom.jpeg, frame_0002_custom.jpeg, ...

--configv1.2.0​

Specify a location for the Remotion config file.

--env-filev2.2.0​

Specify a location for a dotenv file. Default .env.

--jpeg-qualityv4.0.0​

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

--qualityv1.4.0​

Renamed to --jpeg-quality in v4.0.0

--output v4.0.0​

Sets the output file path, as an alternative to the output-location positional argument.

--overwrite​

Write to output even if file already exists.. This flag is enabled by default, use --overwrite=false to disable it.

--sequencev1.4.0​

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

--codecv1.4.0​