Install the SDK
Install the SDK using one of these options:
After installation, Apple M1 users might encounter the error Architecture not supported: ${process.arch}
. To resolve this, first install the Rosetta 2 software by running softwareupdate --install-rosetta
.
Install the SDK with npm
Install the SDK using npm.
Prerequisites for installing the SDK with npm
Ensure you have installed the latest version of npm in your local environment, using Node version 10 or later.
Steps to install the SDK with npm
Run this command to install the SDK for local use:
After installation, you are ready to use the SDK. Run the following command to verify that the SDK works:
Install the SDK using the prebuilt binaries
After you have downloaded the desired binary archive, open a terminal and run the following commands. Note that these commands assume you are running on an Intel-based macOS and downloading version 0.0.5
of the SDK.
To verify that you can use the SDK, run:
Install the SDK with Homebrew
Prerequisites for installing the SDK with Homebrew
You must have a macOS or Linux environment.
Steps to install the SDK with Homebrew
Install the SDK as follows:
Install the SDK with the Windows Scoop package manager
Prerequisites for installing the SDK with the Windows Scoop package manager
You must have a Windows environment.
Steps to install the SDK with the Windows Scoop package manager
Install the SDK as follows:
Install the SDK with Docker
Prerequisites for installing the SDK with Docker
You must have a way to run Linux containers.
Steps to install the SDK with Docker
Pull the Docker image as follows:
Run the SDK by using the following command:
For example, to generate a custom rules template, you can run the following:
More information about the SDK
Last updated