FLAGS & OPTIONS

Complete reference for capysquash-cli flags and options.

💡 Using CAPYSQUASH Platform? Configuration is managed through the web interface. This guide is for capysquash-cli users.

GLOBAL FLAGS

Available for all commands:

Flag	Short	Description	Default
`--config`	`-c`	Config file path	`pgsquash.config.json`
`--verbose`	`-v`	Verbose output	`false`
`--quiet`	`-q`	Suppress output except errors	`false`
`--help`	`-h`	Show help	-
`--version`		Show version	-

Flag	Type	Description	Default
`--safety`	string	Safety level (`paranoid`, `conservative`, `standard`, `aggressive`)	`standard`
`--dry-run`	boolean	Preview without writing files	`false`
`--force`	boolean	Overwrite existing output files	`false`

Flag	Type	Description	Default
`--output`	string	Output directory	`clean/`
`--format`	string	File naming format (`sequential`, `timestamp`, `semantic`)	`sequential`
`--preserve-comments`	boolean	Keep comments from originals	`true`
`--add-headers`	boolean	Add metadata headers	`true`

Flag	Type	Description	Default
`--parallel`	int	Number of parallel workers	CPU cores
`--memory-limit`	int	Memory limit in MB	`1024`
`--streaming`	boolean	Use streaming mode	`false`

Flag	Type	Description	Default
`--detect-cycles`	boolean	Detect circular dependencies	`true`
`--ai-analysis`	boolean	Enable AI-powered analysis	`false`

Flag	Type	Description	Default
`--show-diff`	boolean	Show detailed schema diff	`false`
`--postgres-version`	string	PostgreSQL version for validation	`16`
`--timeout`	int	Validation timeout (seconds)	`300`

Flag	Type	Description	Default
`--deep`	boolean	Deep analysis with AI	`false`
`--report-format`	string	Output format (`text`, `json`, `html`)	`text`
`--export`	string	Export report to file	-

capysquash squash migrations/*.sql

capysquash squash migrations/*.sql \
  --safety conservative \
  --output production/ \
  --preserve-comments \
  --add-headers

capysquash squash migrations/*.sql \
  --parallel 8 \
  --streaming \
  --memory-limit 2048

export ANTHROPIC_API_KEY="sk-ant-..."
capysquash analyze migrations/*.sql --deep --ai-analysis

capysquash squash migrations/*.sql \
  --output clean/ \
  --format timestamp \
  --preserve-comments=false