Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/snyk/snyk-iac-rules
https://github.com/snyk/snyk-iac-rules
infrastructure-as-code
Last synced: 7 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/snyk/snyk-iac-rules
- Owner: snyk
- License: other
- Created: 2021-08-26T14:30:47.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-09T07:39:47.000Z (4 months ago)
- Last Synced: 2024-11-08T15:54:28.040Z (9 days ago)
- Topics: infrastructure-as-code
- Language: Go
- Homepage:
- Size: 9.19 MB
- Stars: 9
- Watchers: 78
- Forks: 13
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-opa - Snyk IaC Rules - Maintain library of Rego rules, run integration tests and build WASM bundles for distribution of rules. The OPA libraries are used to build WASM bundles. (Tools and Utilities / Testing Blogs and Articles)
README
# `snyk-iac-rules` SDK
---
[](https://dl.circleci.com/status-badge/redirect/gh/snyk/snyk-iac-rules/tree/main)
[](https://github.com/snyk/snyk-iac-rules/actions/workflows/main.yml)
[](https://github.com/snyk/snyk-iac-rules/actions/workflows/contract.yml)
[](https://github.com/snyk/snyk-iac-rules/actions/workflows/registries.yml)
[](https://github.com/snyk/snyk-iac-rules)
[](https://github.com/snyk/snyk-iac-rules)
[](https://github.com/snyk/snyk-iac-rules)
`snyk-iac-rules` is a Golang SDK that provides flags for writing, debugging, testing, bundling, and distributing custom rules for the [Snyk IaC CLI](https://github.com/snyk/snyk/).
---
# About
The SDK is a tool for writing, debugging, testing, and bundling custom rules for [Snyk Infrastructure as Code](https://snyk.io/product/infrastructure-as-code-security/). See our [Custom Rules documentation](https://docs.snyk.io/products/snyk-infrastructure-as-code/custom-rules) to learn more.
# Install
The SDK can be installed through multiple channels.
## Install with npm or Yarn
[snyk-iac-rules available as an npm package](https://www.npmjs.com/package/snyk-iac-rules). If you have Node.js installed locally, you can install it by running:
```bash
npm install snyk-iac-rules@latest -g
```
or if you are using Yarn:
```bash
yarn global add snyk-iac-rules
```
## Install with Docker
[snyk-iac-rules available as a docker image](https://hub.docker.com/r/snyk/snyk-iac-rules). If you have Docker installed locally, you can install it by running:
```bash
docker pull snyk/snyk-iac-rules:latest
```
You can then run the container like so:
```bash
docker run --rm -v $(pwd):/app snyk/snyk-iac-rules --help
```
## More installation methods
Standalone executables (macOS, Linux, Windows)
### Standalone executables
Use [GitHub Releases](https://github.com/snyk/snyk-iac-rules/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:
```bash
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.
Install with Homebrew (macOS, Linux)
### Homebrew
Install the SDK from [Snyk tap](https://github.com/snyk/homebrew-tap) with [Homebrew](https://brew.sh) by running:
```bash
brew tap snyk/tap
brew install snyk-iac-rules
```
Scoop (Windows)
### Scoop
Install the SDK from our [Snyk bucket](https://github.com/snyk/scoop-snyk) with [Scoop](https://scoop.sh) 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
```bash
snyk-iac-rules --help
```
For more help, read the documentation about [Snyk Infrastructure as Code](https://docs.snyk.io/snyk-infrastructure-as-code).
# Getting support
We recommend reaching out via the [[email protected]](mailto:[email protected]) email whenever you need help with the SDK or Snyk in general.
* See [DEVELOPMENT.md](DEVELOPMENT.md) for how to setup the environment, add a new command, run the code locally, and run the tests.
* See [RELEASE.md](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.