Skip to content

compozy workspace edit

Edit a registered workspace

For people running agent work6 pages in this section

compozy workspace edit

Edit a registered workspace

compozy workspace edit <name-or-id> [flags]

Examples

  # Rename a workspace
  compozy workspace edit checkout-api --name checkout

  # Clear the workspace default agent
  compozy workspace edit checkout-api --default-agent ""

Options

      --add-dir stringArray      Additional directory to include (repeatable)
      --default-agent string     Override the workspace default agent (set empty to clear)
  -h, --help                     help for edit
      --name string              Rename the workspace
      --remove-dir stringArray   Additional directory to remove (repeatable)
      --sandbox string           Override the workspace sandbox profile (set empty to clear)

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 edit <name-or-id> -o json

On this page