Skip to content
Core ConceptsCLI ReferenceAPI Reference
Config
CompozyOS RuntimeConfig

compozy config edit

Open the selected config overlay in $VISUAL or $EDITOR

Audience
Operators running durable agent work
Focus
Config guidance shaped for scanability, day-two clarity, and operator context.

compozy config edit

Open the selected config overlay in $VISUAL or $EDITOR

compozy config edit [flags]

Options

  -h, --help               help for edit
      --scope string       Edit scope: global or workspace (default "global")
      --workspace string   Override workspace binding (ID, name, or path)

Options inherited from parent commands

      --json            Emit JSON output
  -o, --output string   Output format: human, json, jsonl, or toon (default "human")

Output Formats

Every Compozy command supports -o, --output:

  • human for interactive terminal use
  • json for scripts and other machine-readable consumers
  • jsonl for wait or streaming commands that emit one JSON record per line
  • toon for compact agent-readable summaries

Example:

compozy config edit -o json

compozy config check

Alias for config validate

compozy config get

Get one redacted effective config value

On this page

compozy config editOptionsOptions inherited from parent commandsOutput Formats