Command line reference
How to use
- You can access the CLI by running
npx remotioninside a npm project using remotion,yarn remotioninside a yarn project andpnpm exec remotioninside a pnpm project. For compactness, in the documentation we always saynpx remotion. - Inside an npm script, you don't need the
npxprefix.
Commands
The following commands are available - you can always run them using npx remotion or even without the npx prefix if you put the command inside an npm script.
npx remotion previewnpx remotion rendernpx remotion stillnpx remotion compositionsnpx remotion upgradenpx remotion versionsnpx remotion lambda
Example command
npx remotion render --codec=vp8 src/index.tsx HelloWorld out/video.webm
npx remotion render --codec=vp8 src/index.tsx HelloWorld out/video.webm
Fig.io autocompletion
Install Fig (macOS only) to add Remotion autocomplete to your terminal. Type npx remotion to start get suggestions.