Rspeedy logoRspeedy logo
Rspeedy
Guide
APIs
Blog
Contribute
Guide
APIs
Blog
Contribute

Upgrade Rspeedy

This section explains how to upgrade the project's Rspeedy-related dependencies.

Use upgrade-rspeedy

The Rspeedy project includes several NPM packages with peerDependencies constraints. Unmatched peerDependencies can lead to compilation and runtime errors.

We recommend using the upgrade-rspeedy tool to upgrade the Rspeedy version.

INFO

The upgrade-rspeedy command will not install dependencies for you.

Please remember to install the dependencies with your package manager.

Upgrade to the latest version (recommended)

To upgrade @lynx-js/rspeedy and its plugins to the latest version, use the following command in your project:

npm
pnpm
bun
yarn
npx upgrade-rspeedy@latest

For better performance when using pnpm in a monolithic repository, use pnpm dlx instead of npx.

Upgrade to a specific version

To upgrade @lynx-js/rspeedy and its plugins to a specific version, use the following command in your project:

npm
pnpm
bun
yarn
npx upgrade-rspeedy@0.8.3

Replace the 0.8.3 with the one you would like to install.

Upgrade to a canary version

WARNING

Please note that the canary version of Rspeedy is released solely for testing purposes.

IMPORTANT: Do not use canary versions in production environments.

To upgrade @lynx-js/rspeedy and its plugins to a canary version before release, use the following command:

# Replace the `0.8.2-canary-20250309-870106fc` with your canary version.
pnpm dlx upgrade-rspeedy-canary@0.8.2-canary-20250309-870106fc
Except as otherwise noted, this work is licensed under a Creative Commons Attribution 4.0 International License, and code samples are licensed under the Apache License 2.0.