Skip to content

compozy workspace add

Register a workspace

For people running agent work6 pages in this section

compozy workspace add

Register a workspace

compozy workspace add <path> [flags]

Examples

  # Register a workspace with a stable name
  compozy workspace add "$PWD" --name checkout-api

  # Include an additional directory and set a workspace default agent
  compozy workspace add "$PWD" --name platform --add-dir "$PWD/docs" --default-agent architect

Options

      --add-dir stringArray    Additional directory to include (repeatable)
      --default-agent string   Default agent override for this workspace
  -h, --help                   help for add
      --name string            Optional workspace name
      --sandbox string         Sandbox profile override for this workspace

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 workspace add <path> -o json

On this page