Back to Remotion

npx remotion compositions

packages/docs/docs/cli/compositions.mdx

4.0.4633.1 KB
Original Source
<AvailableFrom v="2.6.12" />

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

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

<Options id="props" />

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

--config

<Options id="config" />

--env-file<AvailableFrom v="2.2.0" />

<Options id="env-file" />

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

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

--port

<Options id="port" />

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

<Options id="public-path" />

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

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

--disable-web-security

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

--disable-headless

<Options id="disable-headless" />

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

<Options id="dark-mode" />

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

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

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

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

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

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

<Options id="chrome-mode" />

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