Skip to main content

Requirements

  • Node.js v20.0.0 or higher
  • One of the supported platforms (see below)

Install via package manager

Supported platforms

Configured native targets in package.json include:

Building from source

If a prebuilt binary for your platform is unavailable, installation may require building from source. Make sure you have the following installed:

Prerequisites

  1. Rust toolchain: install via rustup:
  2. Build essentials: C compiler and related tools:

Build

After installing prerequisites, the package will automatically build when you run:

Verify installation

Troubleshooting

If you see an error about missing binaries, ensure you’re using a supported platform or have the build prerequisites installed.
If you encounter permission issues, try: