Skip to main content
The SDK is the revise package on the public npm registry. You don’t need an account, a token, or a conversation with us to install it.
npm and pnpm install the peer dependencies (React, yjs, y-protocols) for you. On Yarn, list them: yarn add revise yjs y-protocols. For revise/server in Node, also run npm i jsdom. revise is free for evaluation, personal projects, and education. Production use by businesses, nonprofits, and government requires a commercial license. You can build and prototype with it before buying one.

​
Entry points

​
Peer dependencies

React 18 or newer, yjs, and y-protocols are required peers. The SDK never bundles its own copies, and every editor session is Yjs-backed even when you do not attach a collaboration provider: jsdom remains optional and is never installed automatically; only revise/server needs it, and it tells you to npm i jsdom if it is missing.

​
Versioning

The package follows semantic versioning. Pin what you ship:
package.json
Use an exact version, not a range, so upgrades stay deliberate. The package ships a CHANGELOG.md; read it before changing versions. Breaking changes to the component props or the handle controllers arrive in a major version, never a patch.
Versions 1.0.0 and earlier of revise on npm are an unrelated library whose author passed the name on to us. Everything from 2.0.0 onward is the Revise SDK.

​
Coming from @reviseio/sdk

The private @reviseio/sdk package is retired. Replace the dependency with revise, delete the @reviseio lines from .npmrc, and update imports: The named ReviseEditor export still works alongside the new default export.

​
Reporting a problem

Include the build. Both are exported, so your error reporting can attach them automatically:
npm bugs revise opens the support route.

​
Troubleshooting

The package needs React 18 or newer as a peer. On React 17 or earlier the install fails by design.
Two copies of Yjs are loaded. Make your bundler resolve a single yjs, for example with a resolve.dedupe entry in Vite.
That is the unrelated legacy package. Install revise@2 or later.