Skip to main content

npx remotion compositions

Available from v2.6.12.

Print list of composition IDs based on a path of an entry point.

bash
npx remotion compositions <serve-url|entry-file>?
bash
npx remotion compositions <serve-url|entry-file>?

You may pass a Serve URL or an entry point as the first argument, otherwise the entry point will be determined.

Flags​

--props​

Input 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).
From the root component the props can be read using getInputProps().
You may transform input props using calculateMetadata().

note

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

--config​

Specify a location for the Remotion config file.

--env-filev2.2.0​

Specify a location for a dotenv file - Default .env. Read about how environment variables work in Remotion.

--log​

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

info

If you don't feel like passing command line flags every time, consider creating a remotion.config.ts config file.

--port​

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

--public-dirv3.2.13​

The path of the URL where the bundle is going to be hosted. By default it is /, meaning that the bundle is going to be hosted at the root of the domain (e.g. https://localhost:3000/). If you are deploying to a subdirectory (e.g. /sites/my-site/), you should set this to the subdirectory.

--timeout​

Define how long it may take to resolve all delayRender() calls before the composition fetching times out in milliseconds. Default: 30000.

info

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

--ignore-certificate-errors​

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

--disable-web-security​

available since v2.6.5

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

--disable-headless?​

Deprecated - will be removed in 5.0.0. With the migration to Chrome Headless Shell, this option is not functional anymore.

If disabled, the render will open an actual Chrome window where you can see the render happen. The default is headless mode.

--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.
Default: false until v4.0.136, then true from v4.0.137 on because newer Chrome versions don't allow rendering with the --single-process flag.
This flag will be removed in Remotion v5.0.

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

--binaries-directoryv4.0.120​

The directory where the platform-specific binaries and libraries that Remotion needs are located. Those include an ffmpeg and ffprobe binary, a Rust binary for various tasks, and various shared libraries. If the value is set to null, which is the default, then the path of a platform-specific package located at node_modules/@remotion/compositor-* is selected.
This option is useful in environments where Remotion is not officially supported to run like bundled serverless functions or Electron.

--quiet, --q​

Only prints the composition IDs, separated by a space.

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

See also​