CLI Reference

TerraCi command-line interface reference.

Global Options

These options are available for all commands:

Flag	Short	Description
--config	-c	Path to configuration file
--dir	-d	Working directory
--verbose	-v	Enable verbose output
--help	-h	Show help

Commands

Command	Description
generate	Generate CI pipeline (GitLab CI or GitHub Actions)
validate	Validate project structure
graph	Show dependency graph (DOT, PlantUML, list, levels)
init	Initialize configuration (interactive TUI wizard)
cost	Estimate AWS costs from plan files
summary	Post plan results to MR/PR
policy	Pull and check OPA policies
tfupdate	Resolve Terraform dependency versions and sync lock files
version	Show version information

Usage

terraci [command] [flags]

Examples

# Generate pipeline (GitLab CI)
terraci generate -o .gitlab-ci.yml

# Generate pipeline (GitHub Actions)
terraci generate -o .github/workflows/terraform.yml

# Validate with verbose output
terraci validate -v

# Use custom config
terraci -c custom.yaml generate

# Work in different directory
terraci -d /path/to/project validate

# Filter modules by segment
terraci generate --filter environment=production --filter region=us-east-1

Exit Codes

Code	Description
0	Success
1	General error
2	Configuration error
3	Validation error (circular dependencies, etc.)

Environment Variables

Variable	Description
TERRACI_CONFIG	Default config file path
TERRACI_DIR	Default working directory

Version

terraci version

Output:

terraci version v0.1.0
  commit: abc1234
  built:  2024-01-15T10:30:00Z