npx remotion still
Available from v2.3.
Render a still frame based 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>]
If output-location
is not passed, the still will be rendered into the out
folder.
If composition-id
is also not passed, Remotion will let you select a composition.
Flags
--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.
--image-format
jpeg
, png
, webp
or pdf
. The default is png
.
--config
Specify a location for the Remotion config file.
--env-file
Specify a location for a dotenv file - Default .env
. Read about how environment variables work in Remotion.
--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.
--browser-executable
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
.
--frame
Which frame should be rendered. Example --frame=10
. Default 0
.
From v3.2.27, negative values are allowed, with -1
being the last frame.
--bundle-cache
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 to serve 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.
--timeout
Define how long a single frame may take to resolve all delayRender()
calls before it times out in milliseconds. Default: 30000
.
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"
"vulkan"
(from Remotion v4.0.41)"angle-egl"
(from Remotion v4.0.51)
The default is null
, letting Chrome decide, except on Lambda where the default is "swangle"
--user-agent
v3.3.83
Lets you set a custom user agent that the headless Chrome browser assumes.
--offthreadvideo-cache-size-in-bytes
v4.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
--enable-multiprocess-on-linux
v4.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
--ffmpeg-executable
removed in v4.0
Set a custom ffmpeg
executable. If not defined, a ffmpeg
executable will be searched in PATH
.
--ffprobe-executable
--ffprobe-executable
removed in v4.0
Set a custom ffprobe
executable. If not defined, a ffprobe
executable will be searched in PATH
.