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 <entry-file>
bash
npx remotion compositions <entry-file>
Flags
--props
React Props that can be retrieved using getInputProps()
. Must be a serialized JSON string (--props='{"hello": "world"}'
) or a path to a JSON file (./path/to/props.json
).
info
Inline JSON string isn't supported on Windows because it removes the "
character, use a temporary file instead.
--config
Specify a location for the Remotion config file.
--env-file
Specify a location for a dotenv file. Default .env
. Available in v2.2 and later.
--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
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.
--ffmpeg-executable
Set a custom ffmpeg
executable. If not defined, a ffmpeg
executable will be searched in PATH
.
--ffprobe-executable
Set a custom ffprobe
executable. If not defined, a ffprobe
executable will be searched in 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
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.
--disable-headless
Opens an actual browser to observe the composition fetching.
--quiet
, --q
Only prints the composition IDs, separated by a space.