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:
- Get the path from the Config (Can be set using
Config.setEntryPoint("<entry-point>")
). - Look for some common paths i.e.
src/index.ts
,src/index.tsx
src/index.js
,remotion/index.ts
,app/remotion/index.ts
. - 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()
.
Inline JSON string isn't supported on Windows because it removes the "
character, use a temporary file instead.
--height
v3.2.40
--width
v3.2.40
--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-format
v1.4.0
jpeg
or png
- JPEG is faster, but doesn't support transparency. The default image format is jpeg
since v1.1.
--config
v1.2.0
Specify a location for the Remotion config file.
--env-file
v2.2.0
Specify a location for a dotenv file. Default .env
.
--jpeg-quality
v4.0.0
Value between 0 and 100 for JPEG rendering quality. Doesn't work when PNG frames are rendered.
--quality
v1.4.0
--quality
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.
--sequence
v1.4.0
Pass this flag if you want an image sequence as the output instead of a video.
--codec
v1.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-codec
v3.3.42
Set which codec the audio should have. For defaults and possible values, refer to the Encoding guide.
--audio-bitrate
v3.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-bitrate
v3.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-profile
v2.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
.
--crf
v1.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-executable
v1.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
.
--frames
v2.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-frame
v3.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.
--muted
v3.2.1
Disables audio output. This option may only be used when rendering a video.
--enforce-audio-track
v3.2.1
Render a silent audio track if there wouldn't be one otherwise..
--number-of-gif-loops
v3.1.0
Set the looping behavior. This option may only be set when rendering GIFs. See here for more details.
--bundle-cache
v2.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-dir
v3.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
Not to be confused with the --timeout
flag when deploying a Lambda function.
--ignore-certificate-errors
v2.6.5
Results in invalid SSL certificates in Chrome, such as self-signed ones, being ignored.
--disable-web-security
v2.6.5
This will most notably disable CORS in Chrome among other security features.
--disable-headless
v2.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 isswangle
(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"
null
- Chromium's default
Default for local rendering: null
.
Default for Lambda rendering: "swangle"
.
--user-agent
v3.3.83
Lets you set a custom user agent that the headless Chrome browser assumes.
--ffmpeg-executable
--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
--ffprobe-executable
removed in v4.0
Set a custom ffprobe
executable. If not defined, a ffprobe
executable will be searched in PATH
.