Skip to content

Latest commit

 

History

History
326 lines (223 loc) · 5.77 KB

configuration.md

File metadata and controls

326 lines (223 loc) · 5.77 KB

Morphir Configuration Guide

This guide explains how to configure the Morphir CLI and tooling.

Quick Start

Initialize a new workspace:

morphir workspace init

This creates a morphir.toml file and .morphir/ directory. Edit morphir.toml to customize settings.

Configuration Files

Morphir loads configuration from multiple sources, merged in priority order:

Priority Source Path Purpose
1 (lowest) Built-in defaults (compiled in) Sensible defaults
2 System config /etc/morphir/morphir.toml System-wide settings
3 Global user config ~/.config/morphir/morphir.toml User preferences
4 Project config morphir.toml or .morphir/morphir.toml Project settings
5 User override .morphir/morphir.user.toml Local overrides (gitignored)
6 (highest) Environment variables MORPHIR_* Runtime overrides

Higher-priority sources override lower-priority ones for the same setting.

File Locations

Project Configuration

Place morphir.toml in your project root:

my-project/
├── morphir.toml          # Project configuration
├── .morphir/
│   └── morphir.user.toml # User overrides (gitignored)
└── src/

Or use the hidden style with morphir workspace init --hidden:

my-project/
├── .morphir/
│   ├── morphir.toml      # Project configuration
│   └── morphir.user.toml # User overrides
└── src/

Global User Configuration

Create ~/.config/morphir/morphir.toml for settings that apply to all projects:

[logging]
level = "debug"

[ui]
theme = "dark"

System Configuration

Administrators can create /etc/morphir/morphir.toml for organization-wide defaults.

Configuration Sections

[morphir]

Core Morphir settings:

[morphir]
# Morphir IR version constraint (semver syntax)
version = "^3.0.0"

[workspace]

Workspace paths:

[workspace]
# Workspace root (usually left empty)
root = ""

# Output directory for generated artifacts
output_dir = ".morphir"

[ir]

IR processing settings:

[ir]
# IR format version (1-10)
format_version = 3

# Enable strict validation
strict_mode = false

[codegen]

Code generation settings:

[codegen]
# Target languages
targets = ["go", "typescript"]

# Custom template directory
template_dir = ""

# Output format: pretty, compact, minified
output_format = "pretty"

[cache]

Caching settings:

[cache]
# Enable caching
enabled = true

# Cache directory (empty = default)
dir = ""

# Max cache size in bytes (0 = unlimited)
max_size = 0

[logging]

Logging settings:

[logging]
# Log level: debug, info, warn, error
level = "info"

# Log format: text, json
format = "text"

# Log file (empty = stderr)
file = ""

[ui]

UI settings:

[ui]
# Enable colored output
color = true

# Enable interactive mode
interactive = true

# Theme: default, light, dark
theme = "default"

Environment Variables

Override any setting with environment variables using the MORPHIR_ prefix:

# Override logging level
export MORPHIR_LOGGING_LEVEL=debug

# Disable caching
export MORPHIR_CACHE_ENABLED=false

# Set IR format version
export MORPHIR_IR_FORMAT_VERSION=3

# Disable colors
export MORPHIR_UI_COLOR=false

Environment variable names use underscores for nested keys:

  • logging.level → MORPHIR_LOGGING_LEVEL
  • ir.format_version → MORPHIR_IR_FORMAT_VERSION

CLI Commands

View Configuration

Show the resolved configuration:

# Human-readable format
morphir config show

# JSON format (for scripting)
morphir config show --json

Show Configuration Sources

See which files were loaded:

# Human-readable format
morphir config path

# JSON format
morphir config path --json

Example output:

Configuration sources (in priority order):

  [✓] project
      Path: /home/user/my-project/morphir.toml
      Status: loaded
      Priority: 300

  [✗] global
      Path: /home/user/.config/morphir/morphir.toml
      Status: not found
      Priority: 200

Initialize Workspace

Create a new workspace:

# In current directory
morphir workspace init

# In specific directory
morphir workspace init /path/to/project

# With hidden config style
morphir workspace init --hidden

# With custom project name
morphir workspace init --name my-project

# JSON output (for scripting)
morphir workspace init --json

User Overrides

The .morphir/morphir.user.toml file is for personal settings that shouldn't be committed to version control. It's automatically added to .morphir/.gitignore.

Common uses:

  • Debug logging during development
  • Custom cache locations
  • Personal UI preferences

Example:

# .morphir/morphir.user.toml

[logging]
level = "debug"
file = ".morphir/debug.log"

[ui]
theme = "dark"

Validation

The configuration system validates values and reports errors and warnings:

  • Errors (fatal): Invalid log level, negative cache size, malformed paths
  • Warnings (non-fatal): Unknown theme, unusual IR version

Invalid configuration prevents the CLI from running. Warnings are displayed but don't block execution.

Examples

Minimal Configuration

[morphir]
version = "^3.0.0"

[codegen]
targets = ["go"]

Full Configuration

See examples/morphir.toml for a fully commented example.

CI/CD Configuration

For CI environments, use environment variables:

# GitHub Actions example
env:
  MORPHIR_LOGGING_LEVEL: warn
  MORPHIR_UI_COLOR: false
  MORPHIR_UI_INTERACTIVE: false
  MORPHIR_CACHE_DIR: /tmp/morphir-cache

Multi-Target Code Generation

[codegen]
targets = ["go", "typescript", "scala"]
output_format = "pretty"

[logging]
level = "info"