SCAN

Documentation

Find quickstart, configuration reference and CI examples for the SCAN Gradle Plugin.

Getting Started

Quick setup and installation guide to get SCAN running in your project.

Get Started →

User Guide

Comprehensive guide with examples and best practices for using SCAN effectively.

Read Guide →

Configuration

Complete reference for all configuration options and settings.

Configure →

Pattern Reference

Built-in patterns and guide for creating custom detection patterns.

View Patterns →

Basic Usage

Simple examples and common patterns to get you started quickly.

See Examples →

CI/CD Examples

Integration examples for GitHub Actions, Jenkins, GitLab CI and more.

Integrate →

Quick Reference

Installation

plugins {
    id("io.github.theaniketraj.scan") version "2.0.0"
}

Basic Usage

# Run security scan
./gradlew scanForSecrets

# With verbose output
./gradlew scanForSecrets --info