vulnmap-iac-rules

README

vulnmap-iac-rules SDK

---

vulnmap-iac-rules is a Golang SDK that provides flags for writing, debugging, testing, bundling, and distributing custom rules for the Vulnmap IaC CLI.

---

About

The SDK is a tool for writing, debugging, testing, and bundling custom rules for Vulnmap Infrastructure as Code. See our Custom Rules documentation to learn more.

Install

The SDK can be installed through multiple channels.

Install with npm or Yarn

vulnmap-iac-rules available as an npm package. If you have Node.js installed locally, you can install it by running:

npm install vulnmap-iac-rules@latest -g

or if you are using Yarn:

yarn global add vulnmap-iac-rules

Install with Docker

vulnmap-iac-rules available as a docker image. If you have Docker installed locally, you can install it by running:

docker pull khulnasoft-lab/vulnmap-iac-rules:latest

You can then run the container like so:

docker run --rm -v $(pwd):/app khulnasoft-lab/vulnmap-iac-rules --help

More installation methods

Standalone executables (macOS, Linux, Windows)

Standalone executables

Use GitHub Releases to download a standalone executable of Vulnmap CLI for your platform.

For example, to download and run the latest SDK on macOS, you could run:

wget https://github.com/khulnasoft-lab/vulnmap-iac-rules/releases/download/v0.1.0/vulnmap-iac-rules_0.1.0_Darwin_x86_64.tar.gz
chmod +x ./vulnmap-iac-rules
mv ./vulnmap-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 Vulnmap tap with Homebrew by running:

brew tap vulnmap/tap
brew install vulnmap-iac-rules

Scoop (Windows)

Scoop

Install the SDK from our Vulnmap bucket with Scoop on Windows:

scoop bucket add vulnmap https://github.com/khulnasoft-lab/scoop-vulnmap
scoop install vulnmap-iac-rules

---

Getting started with vulnmap-iac-rules

Once you installed the vulnmap-iac-rules SDK, you can verify it's working by running

vulnmap-iac-rules --help

For more help, read the documentation about Vulnmap Infrastructure as Code.

Getting support

We recommend reaching out via the support@khulnasoft.com email whenever you need help with the SDK or Vulnmap 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.