Sigma User Guide

Sigma Documentation

Version: latest

Sigma User Guide
Introducing Sigma
Downloading Sigma
Getting the Binary
Getting the Docker Image
Configuring Sigma
Configuring the AI-augmented SAST checker plug-in
Security considerations for the AI-augmented SAST checker plug-in
Configuration Methods and Precedence
Configuration Options
Configuring Sigma Output
Configuring Sigma with coverity.yml
Configuring Sigma with .sigma-config.yml
Creating a Default Configuration
Customizing Check Attributes
Overriding Severity Levels
Using the Configuration File to Specify Overrides
Environment Variables
Using a Configuration File in a CI/CD Pipeline
Running Sigma in CI/CD
Using the Black Duck Rapid Scan Static Jenkins Plugin
Installing the Black Duck Rapid Scan Static Jenkins Plugin for Sigma
Configuring Sigma as a Jenkins Tool
Installing and Updating Sigma Automatically
Installing Sigma Manually
Working with a Jenkins Freestyle Project
Defining a Freestyle Project for Using Sigma as a Quality Gate
Defining a Freestyle Project for Using Sigma to Report Issues
Controlling How Sigma Executes
Adding Sigma Configuration Files
Setting Sigma Policy Files
Recording Issues
Executing Other Sigma Commands
Working with a Jenkins Pipeline
Defining a Jenkins Pipeline
Configuring a Scripted Pipeline
Configuring a Declarative Pipeline
Viewing Sigma Issues Reports
Using Policies to Define a Quality Gate
Structure of the Policy File
The when Node
The result Node
Policy Examples
Policy Violations Output
Command Reference
The sigma Command
The analyze Subcommand
The checkers Subcommand
The config Subcommand
The docs Subcommand
The explain Subcommand
The metadata Subcommand
Sigma Support Matrix
Language and Framework Support
OS Support
CI/CD System Support
Minimal Hardware Requirements
Release Notes
Sigma Checkers

Introducing Sigma
Downloading Sigma
Configuring Sigma
Running Sigma in CI/CD
Command Reference
Sigma Support Matrix

Back to home page