Back to Remotion

npx remotion lambda compositions

packages/docs/docs/lambda/cli/compositions.mdx

4.0.4614.1 KB
Original Source
<AvailableFrom v="3.3.2" />

Print list of composition IDs from a serve URL, fetched from inside a Lambda function.

API

bash
npx remotion lambda compositions <serve-url>
<details> <summary>Show output</summary> <pre> looped 60 1080x1080 200 (3.33 sec)
cancel-render 30 920x720 100 (3.33 sec)


iframe 30 1080x1080 10 (0.33 sec)


stagger-test 30 1280x720 100 (3.33 sec)


freeze-example 30 1280x720 300 (10.00 sec)


base-spring 30 1080x1080 100 (3.33 sec)


spring-with-duration 30 1080x1080 100 (3.33 sec)


missing-img 30 1080x1080 10 (0.33 sec)


ten-frame-tester 30 1080x1080 10 (0.33 sec)


framer 30 1080x1080 100 (3.33 sec)


skip-zero-frame 30 1280x720 100 (3.33 sec)


scripts 30 1280x720 100 (3.33 sec)


many-audio 30 1280x720 30 (1.00 sec)


error-on-frame-10 30 1280x720 1000000 (33333.33 sec)


wrapped-in-context 1280x720 Still


drop-dots 30 1080x1080 5400 (180.00 sec)
</pre> </details>

remotion lambda compositions vs. remotion compositions

You can also get the compositions of a site that is hosted on S3 locally using npx remotion compositions.
Vice versa, you can also get the compositions from a Serve URL that is not hosted on AWS Lambda using npx remotion lambda compositions.

You should use npx remotion lambda compositions if you cannot use npx remotion compositions because the machine cannot run Chrome.

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

<Options id="env-file" />

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

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

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

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

<Options id="dark-mode" />

--disable-headless

<Options id="disable-headless" />

--quiet, --q

Only prints the composition IDs, separated by a space.

--force-bucket-name<AvailableFrom v="3.3.42" />

Specify a specific bucket name to be used. This is not recommended, instead let Remotion discover the right bucket automatically.

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

Lets you set a custom user agent that the headless Chrome browser assumes.

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

--force-path-style<AvailableFrom v="4.0.202" />

Passes forcePathStyle to the AWS S3 client. If you don't know what this is, you probably don't need it.

See also