Skip to content

compozy desktop update

Rename a virtual desktop

For people running agent work12 pages in this section

compozy desktop update

Rename a virtual desktop

compozy desktop update [flags]

Options

      --actor-id string    Optional actor identifier
      --client string      Connected presentation client ID
  -h, --help               help for update
      --id string          Desktop ID
      --name string        New desktop name
      --origin string      Command origin label (default "cli")
      --revision uint      Expected workspace revision
      --workspace string   Override workspace (ID, name, or path)

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 desktop update -o json

On this page