SupportAPI docsProduct updatesSign up for free
Search…
Snyk User Documentation
Introducing Snyk
Getting started
Snyk CLI
Snyk API
Snyk for IDEs
Snyk Apps
Snyk Integrations
SNYK PRODUCTS
Snyk Open Source
Snyk Code
Snyk Container
Snyk Infrastructure as Code
Getting started with Snyk Infrastructure as Code (IaC)
Using Snyk IaC via web
Scan Terraform files
Scan CloudFormation files
Scan Kubernetes configuration files
Scan ARM configuration files
Snyk Infrastructure as code for self-hosted git (with Broker)
Snyk CLI for Infrastructure as Code
Jira Integration
View Infrastructure as Code issue reports
Build your own custom rules
Install the SDK
Getting started with the SDK
Parsing an input file
Writing a rule
Testing a rule
Bundling rules
Pushing a bundle
Custom Rego Builtins
Examples of custom rules
Use IaC custom rules with CLI
Integrating IaC custom rules within a pipeline
SDK Reference
Detect drift and manually created resources
Share CLI results with the Snyk Web UI
USING SNYK
Snyk Broker
User and group management
Fixing and prioritizing issues
Reports
More Snyk Tools
SNYK INFO
Disclosing vulnerabilities
How Snyk handles your data
SNYK TUTORIALS
Getting Started
Amazon Web Services
Atlassian
CircleCI
Docker
Dynatrace
GCP
GitHub
Microsoft Azure
Oracle Cloud Infrastructure
Red Hat
SpringOne
Powered By GitBook
Getting started with the SDK
To get you started with the SDK, you will learn how to:
  1. 1.
    ​Parse a fixture file in order to help you understand how to write a rule
  2. 2.
    ​​Write a rule with the SDK using Rego
  3. 3.
    ​Add unit tests for the rules you’ve written to verify your rules
  4. 4.
    ​Build a bundle containing your custom rules so that you can use it with the Snyk CLI​
  5. 5.
    ​Push the bundle containing your custom rules to a container registry so that you can enforce its usage with the Snyk CLI​
Development to Distribution Workflow
Previous
Install the SDK
Next
Parsing an input file
Last modified 1mo ago
Export as PDF
Copy link
Edit on GitHub