Installation

The RVE SDK is delivered as a private npm package through the React Video Editor registry. Setup only takes a few minutes: create your account, activate your subscription, generate a registry token, and add it to npm before installing the package.

You'll do most of this from the customer dashboard, so it's worth getting that set up first. If you're planning to use the SDK across local development, CI, and production, you can create separate tokens for each environment later.

Step 1: Create Your Account

Create your React Video Editor account to access the dashboard. This is where you'll manage your subscription, create registry tokens, and view the install details you'll need in the next steps.

If you already have an account, sign in and continue to the token setup section below.

Get Started

Step 2: Create a Registry Token

Once your subscription is active, go to Registry Tokens in the dashboard sidebar and click Create Token. Give it a label so you know where it's being used (e.g. my-laptop, ci-pipeline, vercel-prod).

Create a new registry token

After creating, the portal will show your token once along with the setup commands. Copy the token immediately — you won't be able to see it again.

Token created with setup instructions

Step 3: Configure npm Authentication

Run this command, replacing YOUR_TOKEN with the token you just copied:

npm config set //registry.reactvideoeditor.com/:_authToken=YOUR_TOKEN

Step 4: Install the Package

npm install @reactvideoeditor/react-video-editor --registry https://registry.reactvideoeditor.com

You'll also need to install the peer dependencies if you don't have them already:

npm install react react-dom mediabunny

Step 5: Import the Stylesheet

The SDK ships its own CSS. Import it once at the root of your application:

app/layout.tsx or main.tsx

import '@reactvideoeditor/react-video-editor/styles.css';

Deploying with CI/CD?

If you're using GitHub Actions, Vercel, or another automated environment, you'll want to use a project .npmrc file instead of the global npm config. Create a .npmrc in your project root:

.npmrc

//registry.reactvideoeditor.com/:_authToken=${RVE_TOKEN}
@reactvideoeditor:registry=https://registry.reactvideoeditor.com

Then set RVE_TOKEN as an environment variable in your CI/CD platform. This keeps the token out of version control.

Next Steps

You're installed. Now set up your first editor:

Quick Start — get a working editor on screen in under 5 minutes
Setting Up Rendering — build the API endpoints needed to export video