Requirements
- Node.js v20.0.0 or higher
- One of the supported platforms (see below)
Install via package manager
Supported platforms
Prebuilt native binaries are provided for:| Platform | Architecture |
|---|---|
| macOS | Intel (x64) |
| macOS | Apple Silicon (arm64) |
| Linux | x64 (glibc) |
| Linux | x64 (musl) |
| Linux | arm64 (glibc) |
| Windows | x64 |
Building from source
Prerequisites
-
Rust toolchain — Install via rustup:
-
Build essentials — C compiler and related tools:
- macOS
- Ubuntu/Debian
- Windows
Build
After installing prerequisites, the package will automatically build when you run:Verify installation
Troubleshooting
Binary not found error
Binary not found error
If you see an error about missing binaries, ensure you’re using a supported platform or have the build prerequisites installed.
Permission errors on macOS
Permission errors on macOS
If you encounter permission issues, try: