packages/docs/docs/upgrading.mdx
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import {VERSION} from 'remotion/version';
The easiest way to do this is to run the following command in the root of your project:
<Tabs defaultValue="npx" values={[ { label: 'npx', value: 'npx', }, { label: 'pnpm', value: 'pnpm', }, { label: 'yarn', value: 'yarn', }, { label: 'bunx', value: 'bunx', }, ] }> <TabItem value="npx">
npx remotion upgrade
pnpm exec remotion upgrade
yarn remotion upgrade
bunx remotion upgrade
:::note
You need the @remotion/cli package installed for this.
:::
<Step>1</Step> Edit the version number of all @remotion/* packages and
remotion in your package.json for all packages. The current version is {
VERSION
}
.
<Step>2</Step> Delete the ^ in front of the version number in your
package.json in order to force the exact version you specified.{' '}
<Step>3</Step> Run the install command of your package manager:{' '}
<Tabs defaultValue="npm" values={[ { label: 'npm', value: 'npm', }, { label: 'pnpm', value: 'pnpm', }, { label: 'yarn', value: 'yarn', }, { label: 'bun', value: 'bun', }, ] }> <TabItem value="npm">
npm i
pnpm i
yarn
bun i
Remotion follows semantic versioning.
This means if the first number of the version is the same, you can upgrade and your code is backwards-compatible.
Example: If you are on 4.0.0, you can upgrade to 4.1.100 without changing your code.
However, to upgrade to 5.0, you will need to follow the migration guide.
Exceptions to the breaking change rule are APIs that are marked as experimental.
Visit remotion.dev/changelog to see a list of all changes.
We maintain a repo with the latest stable version of Remotion for customers who need a higher level of stability.
Customers may get access to the repo on the remotion.pro portal.