Skip to content

compozy pair redeem

Redeem a pairing artifact into a named remote profile

For people running agent work3 pages in this section

compozy pair redeem

Redeem a pairing artifact into a named remote profile

compozy pair redeem <artifact> [flags]

Options

      --address string             Gateway HTTPS address
      --default-workspace string   Default remote workspace
  -h, --help                       help for redeem
      --name string                Connection profile name
      --overwrite                  Replace an existing profile with this name
      --use                        Make the new profile active

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 pair redeem <artifact> -o json

On this page