Compozy Symbol
ALPHA
DocsInstallGetting StartedFeaturesPricing
CoreCLI ReferenceSchema DefinitionAPI Reference

Configuration Commands

The `compozy config` command group provides comprehensive tools for managing, validating, and diagnosing your Compozy configuration. These commands ensure your setup is correct, optimized, and ready for production deployment.

Command Overview

compozy config [command] [flags]

Show Configuration

Display current configuration values from all sources with detailed source tracking

Validate Configuration

Check configuration files for syntax errors, missing fields, and invalid values

Configuration Diagnostics

Run comprehensive diagnostics to identify configuration and connectivity issues

Commands

Show Configuration

Display the current configuration values from all sources:

# Show configuration in table format (default)
compozy config show

# Show as YAML
compozy config show --format yaml

# Show as JSON
compozy config show --format json

Flags

FlagDescriptionOptionsDefault
--formatOutput formattable | json | yamltable
--configPath to config file (overrides default locations)File path-

Validate Configuration

Check configuration files for syntax errors and invalid values:

# Validate default config file
compozy config validate

# Validate specific config file
compozy config validate --config ./custom-config.yaml

Flags

FlagDescriptionFormat
--configPath to config file (overrides default locations)File path

Validation Checks:

  • YAML syntax validity
  • Required fields presence
  • Type validation for all fields
  • Value range validation
  • Reference validation ($ref and $use)
  • Environment variable resolution

Configuration Diagnostics

Run comprehensive diagnostics to identify configuration and connectivity issues:

# Run all diagnostics
compozy config diagnostics

# Run with verbose output
compozy config diagnostics --verbose

Flags

FlagDescriptionType
--verboseShow detailed diagnostic informationBoolean

Next Steps

Project Commands
Initialize and manage Compozy projects
Development Commands
Development server and hot reload
Global Configuration
Detailed configuration reference

Authentication Commands

The `compozy auth` command group provides comprehensive authentication and API key management capabilities. These commands support both interactive TUI and automation-friendly JSON output modes.

Workflow Commands

The workflow command group provides comprehensive workflow management capabilities including listing, inspecting, and executing workflows. These commands form the core of workflow orchestration in Compozy.