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-file?> [<composition-id>] [<output-location>]

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

If entry-file is not passed, Remotion will try to detect the entry file with the following priority order:

1. Get the path from the Config (Can be set using Config.setEntryPoint("<entry-point>")).
2. Look for some common paths i.e. src/index.ts, src/index.tsx src/index.js, remotion/index.ts, app/remotion/index.ts.
3. Fail as entry point could not be determined.

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

Flags

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

--props

React 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). Can also be read using getInputProps().

info

Inline JSON string isn't supported on Windows because it removes the " character, use a temporary file 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.

--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

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.

--audio-codecv3.3.42

Set which codec the audio should have. For defaults and possible values, refer to the Encoding guide.

--audio-bitratev3.2.32

Specify the target bitrate for the generated audio.
The syntax for FFMPEGs -b:a parameter should be used.
FFMPEG may encode the video in a way that will not result in the exact audio bitrate specified. Example values: 128K for 128 kbps, 1M for 1 Mbps.
Default: 320k

--video-bitratev3.2.32

Specify the target bitrate for the generated video.
The syntax for FFMPEGs -b:v parameter should be used.
FFMPEG may encode the video in a way that will not result in the exact video bitrate specified.
This option cannot be set if --crf is set. Example values: 512K for 512 kbps, 1M for 1 Mbps.

--prores-profilev2.1.6

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.

--x264-presetv4.2.2

Set the x264 preset. This option is only valid if the codec has been set to h264. Possible values: superfast, veryfast, faster, fast, medium, slow, slower, veryslow, placebo, Default: medium

--crfv1.4.0

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. This option cannot be set if --video-bitrate is set.

--browser-executablev1.5.0

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

--scale

Scales the output frames by the factor you pass in. For example, a 1280x720px frame will become a 1920x1080px frame with a scale factor of 1.5. Vector elements like fonts and HTML markups will be rendered with extra details. scale must be greater than 0 and less than equal to 16. Default: 1.

--framesv2.0.0

Render a subset of a video. Example: --frames=0-9 to select the first 10 frames. To render a still, use the still command.

--every-nth-framev3.1.0

Render only every nth frame. This option may only be set when rendering GIFs. This allows you to lower the FPS of the GIF.

For example only every second frame, every third frame and so on. Only works for rendering GIFs. See here for more details.

--mutedv3.2.1

Disables audio output. This option may only be used when rendering a video.

--enforce-audio-trackv3.2.1

Render a silent audio track if there wouldn't be one otherwise..

--number-of-gif-loopsv3.1.0

Set the looping behavior. This option may only be set when rendering GIFs. See here for more details.

--bundle-cachev2.0.0

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

--log

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

--port

Set a custom HTTP server port that will be used to host the Webpack bundle. If not defined, Remotion will try to find a free port.

--public-dirv3.2.13

Define the location of the public/ directory.. If not defined, Remotion will assume the location is the public folder in your Remotion root.

--ffmpeg-executable

info

Not to be confused with the --timeout flag when deploying a Lambda function.

--ignore-certificate-errorsv2.6.5

Results in invalid SSL certificates in Chrome, such as self-signed ones, being ignored.

--disable-web-securityv2.6.5

This will most notably disable CORS in Chrome among other security features.

--disable-headlessv2.6.5

Opens an actual browser during rendering to observe the render.

--gl

Changelog

• From Remotion v2.6.7 until v3.0.7, the default for Remotion Lambda was swiftshader, but from v3.0.8 the default is swangle (Swiftshader on Angle) since Chrome 101 added support for it.
• From Remotion v2.4.3 until v2.6.6, the default was angle, however it turns out to have a small memory leak that could crash long Remotion renders.

Select the OpenGL renderer backend for Chromium. Accepted values:

• "angle",
• "egl",
• "swiftshader"
• "swangle"
• "vulkan" (from Remotion v4.0.41)
• null - Chromium's default

Default for local rendering: null.
Default for Lambda rendering: "swangle".

--user-agentv3.3.83

Lets you set a custom user agent that the headless Chrome browser assumes.

--offthreadvideo-cache-size-in-bytesv4.0.23

From v4.0, Remotion has a cache for <OffthreadVideo> frames. The default is null, corresponding to half of the system memory available when the render starts.
This option allows to override the size of the cache. The higher it is, the faster the render will be, but the more memory will be used.
The used value will be printed when running in verbose mode.
Default: null

--color-spacev4.0.28

Color space to use for the video. Acceptable values: "default", "bt709"

--enable-multiprocess-on-linuxv4.0.42

Removes the --single-process flag that gets passed to Chromium on Linux by default. This will make the render faster because multiple processes can be used, but may cause issues with some Linux distributions or if window server libraries are missing.

--ffmpeg-executable

removed in v4.0

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

--ffprobe-executable v3.0.17

removed in v4.0

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