Skip to content
Redactyl Redactyl

Getting Started

Installation

Section titled “Installation”
Section titled “Using Go (Recommended)”
Terminal window
go install github.com/varalys/redactyl@latest
redactyl --help

Using Homebrew (macOS/Linux)

Section titled “Using Homebrew (macOS/Linux)”
Terminal window
brew install varalys/tap/redactyl

From Source

Section titled “From Source”
Terminal window
git clone https://github.com/varalys/redactyl.git
cd redactyl
make build
./bin/redactyl --version

Tip: Add the local bin/ to PATH for this shell:

Terminal window
export PATH="$PWD/bin:$PATH"

Quick Start

Section titled “Quick Start”

Interactive Scan (Default)

Section titled “Interactive Scan (Default)”

Navigate to any project directory and run:

Terminal window
redactyl scan

This opens the interactive TUI where you can browse findings, filter by severity, and take action on secrets. The TUI provides:

  • Real-time findings with severity color-coding
  • Vim-style navigation with search, filter, and grouping
  • Syntax-highlighted context preview
  • Quick actions: open in editor, baseline, ignore, export
  • Virtual file extraction from archives
  • Diff view to compare scans

CI/CD Mode (Non-Interactive)

Section titled “CI/CD Mode (Non-Interactive)”

For CI/CD pipelines, disable the TUI:

Terminal window
redactyl scan --no-tui

With Guidance

Section titled “With Guidance”

Get suggested remediation commands:

Terminal window
redactyl scan --guide --no-tui

Output Formats

Section titled “Output Formats”

JSON Output

Section titled “JSON Output”
Terminal window
redactyl scan --json  # Auto-disables TUI

SARIF Output (for GitHub Code Scanning)

Section titled “SARIF Output (for GitHub Code Scanning)”
Terminal window
redactyl scan --sarif > redactyl.sarif.json

Text-Only Format

Section titled “Text-Only Format”
Terminal window
redactyl scan --text --no-tui

Scope Control

Section titled “Scope Control”

Control what gets scanned:

Terminal window
# Staged changes only
redactyl scan --staged


# Last N commits
redactyl scan --history 5


# Diff vs base branch
redactyl scan --base main

Deep Artifact Scanning

Section titled “Deep Artifact Scanning”

Scan containers, Helm charts, and archives. The artifacts that actually run in production:

Terminal window
# Scan container images
redactyl scan --containers


# Scan Helm charts
redactyl scan --helm


# Scan Kubernetes manifests
redactyl scan --k8s


# Scan everything
redactyl scan --archives --containers --helm --k8s

Next Steps

Section titled “Next Steps”