Back to Remotion

npx remotion still

packages/docs/docs/cli/still.mdx

4.0.4764.1 KB
Original Source
<AvailableFrom v="2.3" />

Render a still frame based on the entry point, the composition ID and save it to the output location.

bash
npx remotion still <serve-url|entry-point>? [<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 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

<Options id="props" />

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

--image-format

<Options id="still-image-format" />

--config

<Options id="config" />

--env-file

<Options id="env-file" />

--jpeg-quality <AvailableFrom v="4.0.0" />

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

--quality <AvailableFrom v="1.4.0" />

Renamed to --jpeg-quality in v4.0.0

--output <AvailableFrom v="4.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

<Options id="browser-executable" />

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

<Options id="frame" />

--bundle-cache

<Options id="bundle-cache" />

--log

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

--port

<Options id="port" />

--public-dir<AvailableFrom v="3.2.13" />

<Options id="public-path" />

--timeout

Define how long a single frame may take to resolve all delayRender() calls before it times out in milliseconds. Default: 30000.

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

--ignore-certificate-errors<AvailableFrom v="2.6.5" />

<Options id="ignore-certificate-errors" />

--disable-web-security<AvailableFrom v="2.6.5" />

<Options id="disable-web-security" />

--disable-headless<AvailableFrom v="2.6.5" />

<Options id="disable-headless" />

--dark-mode<AvailableFrom v="4.0.381"/>

<Options id="dark-mode" />

--chrome-mode<AvailableFrom v="4.0.248" />

<Options id="chrome-mode" />

--gl

<Options id="gl" cli />

--user-agent<AvailableFrom v="3.3.83"/>

<Options id="user-agent" />

--media-cache-size-in-bytes<AvailableFrom v="4.0.352"/>

<Options id="media-cache-size-in-bytes" />

--offthreadvideo-cache-size-in-bytes<AvailableFrom v="4.0.23"/>

<Options id="offthreadvideo-cache-size-in-bytes" />

--offthreadvideo-video-threads<AvailableFrom v="4.0.261"/>

<Options id="offthreadvideo-video-threads" />

--enable-multiprocess-on-linux<AvailableFrom v="4.0.42"/>

<Options cli id="enable-multiprocess-on-linux" />

--binaries-directory<AvailableFrom v="4.0.120" />

<Options cli id="binaries-directory" />

--experimental-rspack<AvailableFrom v="4.0.426" />

<Options id="experimental-rspack" />

--ffmpeg-executable

removed in v4.0

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

--ffprobe-executable

removed in v4.0

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