Scanning

Learn how to use Vypher to scan your files and detect sensitive data across different sources and formats.

Overview

Vypher provides powerful scanning capabilities to identify sensitive data in:

Source code repositories
Configuration files
Documentation
Database exports
Log files
Any text-based content

Quick Start

Basic Scan


# Scan current directory
vypher scan .
 
# Scan specific directory
vypher scan /path/to/project
 
# Scan multiple paths
vypher scan src/ docs/ config/

Common Scan Options


# Scan with specific detectors
vypher scan . --detectors pii,secrets
 
# Output to file
vypher scan . --output results.json
 
# Exclude patterns
vypher scan . --exclude "node_modules/,*.log"

Scanning Modes

Basic Usage

Standard file and directory scanning with built-in detectors.

Git History

Scan entire Git history to find sensitive data in past commits.

Output Formats

Configure output in JSON, CSV, XML, or custom formats.

Supported File Types

Vypher can scan various file formats:

Text Files

Source code (.js, .py, .java, .go, etc.)
Configuration files (.yaml, .json, .xml, .ini)
Documentation (.md, .txt, .rst)
Scripts (.sh, .ps1, .bat)

Compressed Archives

ZIP files
TAR archives
GZIP files

Binary File Analysis

Extract metadata
Analyze embedded strings
Process container images

Performance Optimization

Large Repository Scanning


# Parallel processing
vypher scan . --threads 8
 
# Memory optimization
vypher scan . --max-file-size 10MB
 
# Progress tracking
vypher scan . --progress

Incremental Scanning


# Only scan changed files
vypher scan . --incremental
 
# Scan since last commit
vypher scan . --since-commit HEAD~1

Next Steps

Basic Usage - Learn fundamental scanning commands
Git History - Scan repository history
Output Formats - Configure scan results