Skip to content

compozy install

Bootstrap Compozy and create the default general agent

For people running agent work514 pages in this section

compozy install

Bootstrap Compozy and create the default general agent

compozy install [flags]

Examples

  # Create ~/.compozy/config.toml and ~/.compozy/agents/general/AGENT.md
  compozy install

  # Bootstrap non-interactively for automation
  compozy install --provider codex --model gpt-5.6-sol -o json

Options

  -h, --help              help for install
      --model string      Default model to configure without opening the wizard
      --provider string   Default provider to configure without opening the wizard

Options inherited from parent commands

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

Output Formats

The root -o, --output flag accepts these values. A renderer is supported only when this command writes that result; jsonl is for commands that emit one JSON record per line.

FormatCommand result
humanInteractive terminal rendering
jsonMachine-readable JSON rendering
jsonlOne JSON record per line when supported
toonCompact agent-readable rendering

Example:

compozy install -o json

On this page