wheels config diff

Overview

The wheels config diff command compares configuration settings and environment variables between two environments. It helps identify differences in both CFWheels settings files and environment-specific .env files, making it easier to understand configuration variations across development, testing, and production environments.

Command Syntax

wheels config diff <env1> <env2> [--changes-only] [--format=<format>] [--env] [--settings]

Parameters

Parameter

Type

Required

Description

env1

string

Yes

First environment to compare (e.g., development, testing, production)

env2

string

Yes

Second environment to compare

--changes-only

flag

Only show differences, hide identical values

--format

string

Output format: table (default) or json

--env

flag

Compare only environment variables

--settings

flag

Compare only CFWheels settings

Comparison Modes

The command can operate in three modes:

Both (Default) - Compares both settings and environment variables
Environment Variables Only - Use --env flag
Settings Only - Use --settings flag

Basic Usage

Compare All Configurations

# Compare everything between development and production
wheels config diff development production

Compare Only Differences

# Show only the differences, hide identical values
wheels config diff development production --changes-only

Compare Environment Variables Only

# Compare only .env files between environments
wheels config diff development production --env

Compare Settings Only

# Compare only CFWheels settings files
wheels config diff development production --settings

JSON Output Format

# Output comparison as JSON for parsing
wheels config diff development production --format=json

What Gets Compared

Settings Configuration

The command compares:

Base settings from config/settings.cfm
Environment-specific overrides from config/{environment}/settings.cfm
All set() function calls are parsed and compared

Environment Variables

The command compares:

Environment-specific files: .env.{environment}
Falls back to .env for development environment if .env.development doesn't exist
All KEY=VALUE pairs are parsed with proper handling of:
- Comments (lines starting with #)
- Inline comments
- Quoted values (single or double quotes)
- Whitespace trimming

File Locations

Settings Files

config/
├── settings.cfm                 # Base settings
├── development/
│   └── settings.cfm             # Development overrides
├── testing/
│   └── settings.cfm             # Testing overrides
└── production/
    └── settings.cfm             # Production overrides

Environment Files

project_root/
├── .env                         # Base/development environment variables
├── .env.development             # Development-specific variables
├── .env.testing                 # Testing-specific variables
└── .env.production              # Production-specific variables

Output Format

Table Format (Default)

The table output is organized into clear sections:

========================================
Configuration Comparison: development vs production
========================================

[SETTINGS CONFIGURATION]

Different Values:
┌──────────────────────┬────────────┬────────────┐
│ Setting              │ development│ production │
├──────────────────────┼────────────┼────────────┤
│ showDebugInformation │ true       │ false      │
│ cacheQueries         │ false      │ true       │
└──────────────────────┴────────────┴────────────┘

Only in development:
┌─────────────────┬──────────┐
│ Setting         │ Value    │
├─────────────────┼──────────┤
│ debugPlugin     │ true     │
└─────────────────┴──────────┘

Only in production:
┌─────────────────┬──────────┐
│ Setting         │ Value    │
├─────────────────┼──────────┤
│ forceSSL        │ true     │
└─────────────────┴──────────┘

[ENVIRONMENT VARIABLES]

Different Values:
┌──────────────┬────────────────┬────────────────┐
│ Variable     │ development    │ production     │
├──────────────┼────────────────┼────────────────┤
│ DB_NAME      │ app_dev        │ app_prod       │
│ DEBUG_MODE   │ true           │ false          │
└──────────────┴────────────────┴────────────────┘

========================================
SUMMARY
========================================
Settings:
  Total: 25
  Identical: 20
  Different: 2
  Unique: 3

Environment Variables:
  Total: 15
  Identical: 10
  Different: 2
  Unique: 3

Overall:
  Total configurations: 40
  Identical: 30
  Different: 4
  Unique: 6
  Similarity: 75%

JSON Format

{
  "env1": "development",
  "env2": "production",
  "comparisons": {
    "settings": {
      "identical": [...],
      "different": [...],
      "onlyInFirst": [...],
      "onlyInSecond": [...]
    },
    "env": {
      "identical": [...],
      "different": [...],
      "onlyInFirst": [...],
      "onlyInSecond": [...]
    }
  },
  "summary": {
    "settings": {
      "totalSettings": 25,
      "identical": 20,
      "different": 2,
      "onlyInFirst": 1,
      "onlyInSecond": 2
    },
    "env": {
      "totalVariables": 15,
      "identical": 10,
      "different": 2,
      "onlyInFirst": 1,
      "onlyInSecond": 2
    },
    "overall": {
      "total": 40,
      "identical": 30,
      "different": 4,
      "unique": 6,
      "similarity": 75
    }
  }
}

Security Features

Automatic Masking

The command automatically masks sensitive values containing these keywords:

password
secret
key
token
apikey/api_key
private
credential
auth
passphrase
salt

Masked values appear as ***MASKED*** in the output.

Example

┌──────────────┬────────────────┬────────────────┐
│ Variable     │ development    │ production     │
├──────────────┼────────────────┼────────────────┤
│ DB_PASSWORD  │ ***MASKED***   │ ***MASKED***   │
│ API_KEY      │ ***MASKED***   │ ***MASKED***   │
└──────────────┴────────────────┴────────────────┘

Common Use Cases

Pre-Deployment Verification

# Verify configuration differences before deploying to production
wheels config diff testing production --changes-only

Environment Synchronization Check

# Check if development and testing have similar configurations
wheels config diff development testing

Security Audit

# Review all security-related settings between environments
wheels config diff development production --settings | grep -i "debug\|error\|ssl"

CI/CD Pipeline Integration

# In your deployment script
wheels config diff staging production --format=json > config-diff.json
# Parse JSON to validate critical settings match expectations

Environment Variable Validation

# Ensure all required environment variables exist in production
wheels config diff development production --env --changes-only

Quick Similarity Check

# Get a quick overview of configuration similarity
wheels config diff development testing | grep "Similarity:"

Examples

Example 1: Basic Comparison

wheels config diff development production

Shows all differences and similarities between development and production configurations.

Example 2: Changes Only

wheels config diff testing production --changes-only

Shows only the differences, useful for quick reviews.

Example 3: Environment Variables Focus

wheels config diff development staging --env --changes-only

Shows only environment variable differences between development and staging.

Example 4: JSON for Automation

wheels config diff development production --format=json | jq '.summary.overall.similarity'

Outputs similarity percentage for automated checks.

Example 5: Settings Validation

wheels config diff development production --settings --changes-only

Validates only CFWheels settings differences.

Error Handling

Environment Not Found

Warning: Settings for environment 'staging' not found!

The command continues with available data and shows warnings for missing files.

No Configuration File

Warning: No settings.cfm file found in config directory

The command will still compare environment variables if available.

Same Environment Comparison

Error: Cannot compare an environment to itself

You must specify two different environments.

Invalid Format

Error: Invalid format: xml. Valid formats are: table, json

Only table and json formats are supported.

Best Practices

Regular Comparisons - Run comparisons before each deployment to catch unintended changes
Use --changes-only for Reviews - Focus on differences during code reviews
Automate with JSON - Use JSON output in CI/CD pipelines for automated validation
Document Differences - Keep a record of intentional differences between environments
Security First - Always review security-related settings (debug, error handling, SSL)
Version Control - Track both settings files and environment files in version control (except sensitive .env files)

Tips

Use --changes-only to quickly identify configuration drift
Pipe JSON output to jq for advanced filtering and processing
Create aliases for common comparisons (e.g., alias cfgdiff='wheels config diff')
Review the similarity percentage as a quick health check
Use the command before and after configuration changes to verify impact
Combine with wheels config check for comprehensive configuration validation

File Format Examples

Settings File (config/production/settings.cfm)

<cfscript>
// Production-specific settings
set(showDebugInformation = false);
set(showErrorInformation = false);
set(sendEmailOnError = true);
set(errorEmailAddress = "[email protected]");
set(cacheQueries = true);
set(forceSSL = true);
</cfscript>

Environment File (.env.production)

# Production Environment Variables
WHEELS_ENV=production

# Database Configuration
DB_HOST=prod.database.com
DB_PORT=3306
DB_NAME=app_production
DB_USER=prod_user
DB_PASSWORD=secure_password_here

# Application Settings
DEBUG_MODE=false
LOG_LEVEL=error
SESSION_TIMEOUT=30

# API Keys
API_KEY=prod_api_key_here
SECRET_KEY=prod_secret_key

Troubleshooting

Files Not Being Read

Ensure files exist in the correct locations
Check file permissions (must be readable)
Verify file naming conventions (.env.{environment})

Parsing Issues

Check for syntax errors in settings.cfm files
Ensure .env files use proper KEY=VALUE format
Remove any special characters that might cause parsing errors

Missing Comparisons

If using --env or --settings, ensure you're not filtering out the data you want
Check that both environments have the respective files

Performance Issues

Large configuration files may take time to parse
Consider using --changes-only to reduce output
Use JSON format for faster processing in scripts

wheels config check - Validate configuration for issues
wheels get environment - Display current environment
wheels env merge - Merge environment configurations
wheels env set - Set environment variables

Summary

The wheels config diff command is an essential tool for managing multi-environment CFWheels applications. It provides comprehensive comparison capabilities for both application settings and environment variables, helping teams maintain consistency and catch configuration drift before it causes issues in production.

Previouswheels config check Nextwheels config dump

Last updated 2 days ago

Was this helpful?

Overview

Command Syntax

Parameters

Comparison Modes

Basic Usage

Compare All Configurations

Compare Only Differences

Compare Environment Variables Only

Compare Settings Only

JSON Output Format

What Gets Compared

Settings Configuration

Environment Variables

File Locations

Settings Files

Environment Files

Output Format

Table Format (Default)

JSON Format

Security Features

Automatic Masking

Example

Common Use Cases

Pre-Deployment Verification

Environment Synchronization Check

Security Audit

CI/CD Pipeline Integration

Environment Variable Validation

Quick Similarity Check

Examples

Example 1: Basic Comparison

Example 2: Changes Only

Example 3: Environment Variables Focus

Example 4: JSON for Automation

Example 5: Settings Validation

Error Handling

Environment Not Found

No Configuration File

Same Environment Comparison

Invalid Format

Best Practices

Tips

File Format Examples

Settings File (config/production/settings.cfm)

Environment File (.env.production)

Troubleshooting

Files Not Being Read

Parsing Issues

Missing Comparisons

Performance Issues

Related Commands

Summary