Skip to content

compozy desktop clients register

Register or refresh a client-local desktop view

For people running agent work4 pages in this section

compozy desktop clients register

Register or refresh a client-local desktop view

compozy desktop clients register [flags]

Options

      --client string      Stable client ID; generated when omitted
      --desktop string     Initial active desktop ID
  -h, --help               help for register
      --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 clients register -o json

On this page