Command line reference
import {AngleChangelog} from '../../components/AngleChangelog'; import {TableOfContents} from '../../components/TableOfContents/cli';
How to use
- You can access the CLI by running
npx remotion
inside a npm project using remotion,yarn remotion
inside a yarn project andpnpm exec remotion
inside a pnpm project. For compactness, in the documentation we always saynpx remotion
. - Inside an npm script, you don't need the
npx
prefix.
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.
Example command
npx remotion render --codec=vp8 HelloWorld out/video.webm
npx remotion render --codec=vp8 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.