Skip to content

compozy agent soul write

Create or replace SOUL.md through managed authoring

For people running agent work7 pages in this section

compozy agent soul write

Create or replace SOUL.md through managed authoring

compozy agent soul write <agent> [flags]

Examples

  compozy agent soul write coder --file SOUL.md --expected-digest sha256:old --workspace checkout-api --json

Options

      --expected-digest string   Expected current Soul digest for CAS
      --file string              Read authored context body from a file
  -h, --help                     help for write
      --idempotency-key string   Optional idempotency key
      --stdin                    Read authored context body from stdin
      --workspace string         Override workspace context (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 agent soul write <agent> -o json

On this page