CompozyOS RuntimeInstall

compozy install

Bootstrap Compozy and create the default general agent

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

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

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 install -o json

compozy vault put

Store one write-only vault secret from stdin

compozy config

Inspect and mutate Compozy configuration

On this page

compozy install Examples Options Options inherited from parent commands Output Formats