Install the SDK using one of these options:
- Install the SDK with npm
- Install the SDK using the prebuilt binaries
- Install the SDK with Homebrew
- Install the SDK with the Windows Scoop package manager
- Install the SDK with Docker
After installation, you can get started writing rules. For details, see Writing rules using the SDK.
{% hint style="info" %}
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
.
{% endhint %}
Install the SDK using npm.
Ensure you have installed the latest version of npm in your local environment, using Node version 10 or later.
Run this command to install the SDK for local use:
npm install -g snyk-iac-rules
After installation, you are ready to use the SDK. Run the following command to verify that the SDK works:
snyk-iac-rules --help
You can download and use the SDK's prebuilt binaries. To download the prebuilt binary, visit the Releases tab on the SDK repository page in GitHub:
Releases tab on the SDK repository page
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.
$ tar xzf snyk-iac-rules_0.0.5_Darwin_x86_64.tar.gz
$ sudo mv snyk-iac-rules /usr/local/bin
To verify that you can use the SDK, run:
snyk-iac-rules --help
From macOS and Linux environments, you can use Homebrew to install the Snyk SDK. The repository for installation is stored in the Snyk GitHub.
-
You must have a macOS or Linux environment.
-
Ensure Homebrew has already been installed:
brew tap snyk/tap
Install the SDK as follows:
brew install snyk-iac-rules
From Windows environments, you can use Scoop to install the snyk-iac-rules
SDK. The repository for installation is stored in the Snyk GitHub.
-
You must have a Windows environment.
-
Ensure Scoop has already been installed:
scoop bucket add snyk https://github.com/snyk/scoop-snyk
Install the SDK as follows:
scoop install snyk-iac-rules
You can use Docker to install and run the snyk-iac-rules
SDK while writing your custom rules in your local directory. The image is stored in the Snyk Docker Hub repo.
- Ensure Docker has already been installed.
- You must have a way to run Linux containers.
Pull the Docker image as follows:
docker pull snyk/snyk-iac-rules
Run the SDK by using the following command:
docker run --rm -v $(pwd):/app snyk/snyk-iac-rules {SDK command}
For example, to generate a custom rules template, you can run the following:
docker run --rm -v $(pwd):/app snyk/snyk-iac-rules template -r {rule_name}