Skip to content

on-progress.md

Latest commit

 

History

History
52 lines (36 loc) · 1.34 KB

on-progress.md

File metadata and controls

52 lines (36 loc) · 1.34 KB
Raw

on-progress

Handler block run on each progress event while an agent runs.
Kind Attribute
Since 0.1.4

Syntax

on progress
  <body>

Description

Block-form child of agent. The body is a normal kilnx body (typically a query or broadcast). It runs once per progress event emitted while the agent subprocess runs. Inside the body these bindings are available, in addition to the surrounding params:

  • :progress, short human-readable line.
  • :progress_kind, one of session, text, assistant, tool, done.
  • :cost_usd, running cost in USD.
  • :session_id, claude session id, populated once the session event fires (the first event the subprocess emits, before any text/tool).

Written in source as two tokens (on progress), generated docs use the hyphenated form on-progress. A failing handler body is logged and does not abort the agent or the job.

Used in

Examples

Persist progress for a polling UI

job run-review
  llm review
    model: claude-sonnet-4-6
    agent
      cwd: :bundle_dir
      max-budget-usd: 2.00
      on progress
        query: UPDATE review_job SET progress = :progress WHERE id = :job_id

Provenance
Spec last touched 36bcf1b (2026-05-20)