Skip to content
Core ConceptsCLI ReferenceAPI Reference
AgentHeartbeat
AGH RuntimeAgent

agh agent heartbeat write

Create or replace HEARTBEAT.md through managed authoring

Audience
Operators running durable agent work
Focus
Agent guidance shaped for scanability, day-two clarity, and operator context.

agh agent heartbeat write

Create or replace HEARTBEAT.md through managed authoring

agh agent heartbeat write <agent> [flags]

Examples

  agh agent heartbeat write coder --file HEARTBEAT.md --if-match sha256:old --json

Options

      --file string              Read authored context body from a file
  -h, --help                     help for write
      --idempotency-key string   Optional idempotency key
      --if-match string          Expected current Heartbeat digest for CAS
      --stdin                    Read authored context body from stdin
      --workspace string         Resolve the agent from a 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

Every AGH command supports -o, --output:

  • human for interactive terminal use
  • json for scripts and other machine-readable consumers
  • jsonl for wait or streaming commands that emit one JSON record per line
  • toon for compact agent-readable summaries

Example:

agh agent heartbeat write <agent> -o json

agh agent heartbeat wake

Request one manual advisory Heartbeat wake

agh agent soul

Inspect and manage agent SOUL.md files

On this page

agh agent heartbeat writeExamplesOptionsOptions inherited from parent commandsOutput Formats