> For the complete documentation index, see [llms.txt](https://docs.snyk.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.snyk.io/scan-fix-and-prevent/scan-with-snyk/snyk-iac/current-iac-custom-rules/install-the-sdk.md).
# Install the SDK
Install the SDK using one of these options:
* [Install the SDK with npm](#install-the-sdk-with-npm)
* [Install the SDK using the prebuilt binaries](#install-the-sdk-using-the-prebuilt-binaries)
* [Install the SDK with Homebrew](#install-the-sdk-with-homebrew)
* [Install the SDK with the Windows Scoop package manager](#install-the-sdk-with-the-windows-scoop-package-manager)
* [Install the SDK with Docker](#install-the-sdk-with-docker)
After installation, you can get started writing rules. For details, see [Writing rules using the SDK](/scan-fix-and-prevent/scan-with-snyk/snyk-iac/current-iac-custom-rules/writing-rules-using-the-sdk.md).
{% 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 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:
```
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
```
## Install the SDK using the prebuilt binaries
You can download and use the SDK's prebuilt binaries. To download the prebuilt binary, visit the [**Releases tab**](https://github.com/snyk/snyk-iac-rules/releases) 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
```
## Install the SDK with Homebrew
From macOS and Linux environments, you can use Homebrew to install the Snyk SDK. The repository for installation is stored in the [Snyk GitHub](https://github.com/snyk/homebrew-tap).
### **Prerequisites for installing the SDK with Homebrew**
* You must have a macOS or Linux environment.
* Ensure [Homebrew](https://brew.sh/) has already been installed:
```
brew tap snyk/tap
```
### **Steps to install the SDK with Homebrew**
Install the SDK as follows:
```
brew install snyk-iac-rules
```
## Install the SDK with the Windows Scoop package manager
From Windows environments, you can use Scoop to install the `snyk-iac-rules` SDK. The repository for installation is stored in the [Snyk GitHub](https://github.com/snyk/scoop-snyk).
### **Prerequisites for installing the SDK with the Windows Scoop package manager**
* You must have a Windows environment.
* Ensure [Scoop](https://scoop.sh) has already been installed:
```
scoop bucket add snyk https://github.com/snyk/scoop-snyk
```
### **Steps to install the SDK with the Windows Scoop package manager**
Install the SDK as follows:
```
scoop install snyk-iac-rules
```
## Install the SDK with Docker
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](https://hub.docker.com/r/snyk/snyk-iac-rules).
### **Prerequisites for installing the SDK with Docker**
* Ensure [Docker](https://docs.docker.com/get-docker/) has already been installed.
* You must have a way to run Linux containers.
### **Steps to install the SDK with Docker**
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}
```
## More information about the SDK
* [Getting started with the SDK](/scan-fix-and-prevent/scan-with-snyk/snyk-iac/current-iac-custom-rules/writing-rules-using-the-sdk.md)
* [SDK reference](/scan-fix-and-prevent/scan-with-snyk/snyk-iac/current-iac-custom-rules/sdk-reference.md)
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.snyk.io/scan-fix-and-prevent/scan-with-snyk/snyk-iac/current-iac-custom-rules/install-the-sdk.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.