Skip to content

compozy agent update

Update an agent definition for future sessions

For people running agent work25 pages in this section

compozy agent update

Update an agent definition for future sessions

compozy agent update <name> [flags]

Options

      --category stringArray        Agent category path segment (repeatable)
      --command string              Optional provider command override
      --deny-tool stringArray       Denied tool pattern (repeatable)
      --disable-skill stringArray   Disabled skill name (repeatable)
      --expected-digest string      Definition digest from the last read
  -h, --help                        help for update
      --model string                Optional provider model
      --permissions string          Optional permission mode
      --prompt string               Agent system prompt body
      --prompt-file string          Read the agent system prompt body from a file
      --provider string             Provider name for sessions using this agent
      --reasoning-effort string     Optional default reasoning effort
      --tool stringArray            Allowed tool pattern (repeatable)
      --toolset stringArray         Allowed toolset reference (repeatable)
      --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 update <name> -o json

On this page