.scaffold.env.example

# Example configuration file for Python Project Deployment Scaffolder
# Copy this file to .scaffold.env and customize as needed
#
# Configuration precedence: CLI args > Environment variables > .env file > defaults

# ============================================================================
# TIMEOUT SETTINGS (in seconds)
# ============================================================================

# Timeout for git operations (clone, init, commit, etc.)
# Valid range: 1-300 seconds
# Default: 30
#SCAFFOLD_TIMEOUT_GIT=30

# Timeout for package installation (pip, uv sync, etc.)
# Valid range: 60-3600 seconds
# Default: 600
#SCAFFOLD_TIMEOUT_INSTALL=600

# Timeout for running tests (pytest, coverage, etc.)
# Valid range: 30-1800 seconds
# Default: 300
#SCAFFOLD_TIMEOUT_TEST=300

# Timeout for building documentation (sphinx-build)
# Valid range: 30-900 seconds
# Default: 180
#SCAFFOLD_TIMEOUT_DOCS=180

# ============================================================================
# SECURITY SETTINGS
# ============================================================================

# Whether to validate binary executables before use
# Valid values: true, false
# Default: true
#SCAFFOLD_VALIDATE_BINARIES=true

# ============================================================================
# LOGGING SETTINGS
# ============================================================================

# Logging level for scaffolder operations
# Valid values: DEBUG, INFO, WARNING, ERROR, CRITICAL
# Default: INFO
#SCAFFOLD_LOG_LEVEL=INFO

# Optional path to log file for persistent logging
# Leave unset to log only to console
# Default: None
#SCAFFOLD_LOG_FILE=/path/to/scaffold.log

# ============================================================================
# USAGE EXAMPLES
# ============================================================================

# Example 1: Increase timeouts for slow network or CI environments
#SCAFFOLD_TIMEOUT_GIT=60
#SCAFFOLD_TIMEOUT_INSTALL=900
#SCAFFOLD_TIMEOUT_TEST=600

# Example 2: Enable debug logging for troubleshooting
#SCAFFOLD_LOG_LEVEL=DEBUG
#SCAFFOLD_LOG_FILE=./scaffold-debug.log

# Example 3: Strict security settings
#SCAFFOLD_VALIDATE_BINARIES=true

# ============================================================================
# NOTES
# ============================================================================

# 1. Environment variables take precedence over .env file values
# 2. CLI arguments take precedence over environment variables
# 3. All SCAFFOLD_* variables are case-insensitive
# 4. Boolean values can be: true/false, yes/no, 1/0
# 5. Invalid values will trigger validation errors with helpful messages