Skip to content
Cli referenceOnboarding
CompozyOS RuntimeOnboarding

compozy onboarding

Inspect and manage first-run onboarding state

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

compozy onboarding

Inspect and manage first-run onboarding state

Options

  -h, --help   help for onboarding

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

Subcommands

CommandDescription
compozy onboarding completeMark first-run onboarding as completed
compozy onboarding resetClear the onboarding completion flag so the wizard runs again
compozy onboarding statusShow whether first-run onboarding has been completed

On this page