CLI options
The default command in package.json that powers npm run build
is:
#
FlagsBesides choosing a video and output location with the command line arguments, the following flags are supported:
--props
: React Props to pass to the root component of your video. Must be a serialized JSON string.--concurrency
: How many CPU threads to use. Minimum 1. The maximum is the amount of threads you have.--pixel-format
: Set a custom pixel format. See here for available values.--image-format
:jpeg
orpng
- JPEG is faster, but supports transparency. The default image format isjpeg
since v1.1. Flag available since v1.4.--config
: Specify a location for the Remotion config file. Available in v1.2 and later.--quality
: Value between 0 and 100 for JPEG rendering quality. Doesn't work when PNG frames are rendered. Available since v1.4.--overwrite
: Write to output even if file already exists.--sequence
: Pass this flag if you want an image sequence as the output instead of a video. Available since v1.4.--codec
:h264
orh265
orpng
orvp8
orvp9
. If you don't supply--codec
, it will use the H.264 encoder. Available since v1.4.--crf
: 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.
info
If you don't feel like passing command line flags every time, consider creating a remotion.config.ts
config file.