Awesome
snyk-iac-rules SDK
snyk-iac-rules is a Golang SDK that provides flags for writing, debugging, testing, bundling, and distributing custom rules for the Snyk IaC CLI.
About
The SDK is a tool for writing, debugging, testing, and bundling custom rules for Snyk Infrastructure as Code. See our Custom Rules documentation to learn more.
<!--- This should be generated automatically from the UML code. We need to specify the branch name though, and this can not happen while we are in main. We need to get the branch name first if we continue using two branches. For now, we can use the rendered image instead.  -->
Install
The SDK can be installed through multiple channels.
Install with npm or Yarn
snyk-iac-rules available as an npm package. If you have Node.js installed locally, you can install it by running:
npm install snyk-iac-rules@latest -g
or if you are using Yarn:
yarn global add snyk-iac-rules
Install with Docker
snyk-iac-rules available as a docker image. If you have Docker installed locally, you can install it by running:
docker pull snyk/snyk-iac-rules:latest
You can then run the container like so:
docker run --rm -v $(pwd):/app snyk/snyk-iac-rules --help
More installation methods
<details> <summary>Standalone executables (macOS, Linux, Windows)</summary>Standalone executables
Use GitHub Releases to download a standalone executable of Snyk CLI for your platform.
For example, to download and run the latest SDK on macOS, you could run:
wget https://github.com/snyk/snyk-iac-rules/releases/download/v0.1.0/snyk-iac-rules_0.1.0_Darwin_x86_64.tar.gz
chmod +x ./snyk-iac-rules
mv ./snyk-iac-rules /usr/local/bin/
Drawback of this method is, that you will have to manually keep the SDK up to date.
</details> <details> <summary>Install with Homebrew (macOS, Linux)</summary>Homebrew
Install the SDK from Snyk tap with Homebrew by running:
brew tap snyk/tap
brew install snyk-iac-rules
Scoop
Install the SDK from our Snyk bucket with Scoop on Windows:
scoop bucket add snyk https://github.com/snyk/scoop-snyk
scoop install snyk-iac-rules
Getting started with snyk-iac-rules
Once you installed the snyk-iac-rules SDK, you can verify it's working by running
snyk-iac-rules --help
For more help, read the documentation about Snyk Infrastructure as Code.
Getting support
We recommend reaching out via the support@snyk.io email whenever you need help with the SDK or Snyk in general.
- See DEVELOPMENT.md for how to setup the environment, add a new command, run the code locally, and run the tests.
- See RELEASE.md for how to release a new version of the SDK.
Contributing
This project is open source but we don't encourage outside contributors.