Skip to content

compozy agent heartbeat write

Create or replace HEARTBEAT.md through managed authoring

For people running agent work9 pages in this section

compozy agent heartbeat write

Create or replace HEARTBEAT.md through managed authoring

compozy agent heartbeat write <agent> [flags]

Examples

  compozy agent heartbeat write coder --file HEARTBEAT.md --expected-digest sha256:old --json

Options

      --expected-digest string   Expected current Heartbeat digest for CAS
      --file string              Read authored context body from a file
  -h, --help                     help for write
      --idempotency-key string   Optional idempotency key
      --if-match string          Alias for --expected-digest
      --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 heartbeat write <agent> -o json

compozy agent heartbeat wake

Request one manual advisory Heartbeat wake

Overview

Inspect and manage agent SOUL.md files

On this page

compozy agent heartbeat writeExamplesOptionsOptions inherited from parent commandsOutput Formats