Skip to main content

npx remotion studio

Alias: npx remotion preview

Start the Remotion Studio.

npx remotion studio <entry-point>?

You may pass an entry point as an argument, otherwise it 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).
note

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

--configv1.2.0​

Specify a location for the Remotion config file.

--env-filev2.2.0​

Specify a location for a dotenv file. Default .env.

--log​

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

--port​

Set a custom HTTP server port for the Studio or the render process. 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.

--disable-keyboard-shortcutsv3.2.11​

Enable or disable keyboard shortcuts in the Remotion Studio.

--enable-experimental-client-side-renderingv4.0.387​

Enable WIP client-side rendering in the Remotion Studio. See https://www.remotion.dev/docs/client-side-rendering/ for notes.

--experimental-rspackv4.0.426​

Uses Rspack instead of Webpack as the bundler for the Studio or bundle.

--webpack-pollv3.3.11​

Enables Webpack polling instead of the file system event listeners for hot reloading. This is useful if you are inside a virtual machine or have a remote file system. Pass a value in milliseconds.

--no-openv3.3.19​

If specified, Remotion will not open a browser window when starting the Studio.

--browserv3.3.79​

Specify the browser which should be used for opening a tab. The default browser will be used by default. Pass an absolute path or "chrome" to use Chrome. If Chrome is selected as the browser and you are on macOS, Remotion will try to reuse an existing tab.

You can also configure the browser via environment variables for backwards compatibility:

  • BROWSER behaves like the --browser flag.
  • BROWSER_ARGS behaves like the --browser-args flag.
  • Setting BROWSER=none disables auto-opening of the browser (equivalent to --no-open).

--browser-argsv3.3.79​

A set of command line flags that should be passed to the browser. Pass them like this:

npx remotion studio --browser-args="--disable-web-security"

--beep-on-finishv4.0.84​

Plays a beep sound when the video is finished rendering. This is useful if you are rendering a video in the background and want to be notified when it is finished.

npx remotion studio --beep-on-finish

--ipv4v4.0.125​

Forces Remotion to bind to an IPv4 interface for the Studio server. 
npx remotion studio --ipv4

--number-of-shared-audio-tagsv3.3.2​

Set number of shared audio tags. See Using the numberOfSharedAudioTags prop for more information. 
npx remotion studio --number-of-shared-audio-tags=5

--cross-site-isolationv4.0.364​

Enable Cross-Site Isolation in the Studio.

npx remotion studio --enable-cross-site-isolation

--disable-ask-aiv4.0.407​

Disable the Ask AI modal in the Studio.

npx remotion studio --disable-ask-ai

--force-newv4.0.421​

Forces starting a new Studio instance even if one is already running on the same port for the same project. 
npx remotion studio --force-new

--public-license-keyv4.0.398​

The public license key for your company license, obtained from the "Usage" tab on remotion.pro. If you are eligible for the free license, pass "free-license". 
npx remotion studio --public-license-key="your-license-key"