JSON 事件流模式

pi --mode json "Your prompt"

將所有工作階段事件以 JSON line 輸出到 stdout。適合將 pi 整合到其他工具或自訂 UI 中。

線上事件使用 JsonAgentSessionEvent。它與 AgentSessionEvent 比對，但串流訊息更新會省略累積快照：

type WithoutPartial<T> = T extends { partial: unknown } ? Omit<T, "partial"> : T;

type JsonAgentSessionEvent =
  | Exclude<AgentSessionEvent, { type: "message_update" }>
  | {
      type: "message_update";
      assistantMessageEvent: WithoutPartial<AssistantMessageEvent>;
    };

每當佇列發生變化時，queue_update 都會發出完整的待處理中途引導和後續訊息佇列。compaction_start 和 compaction_end 覆蓋手動和自動壓縮。

其他基礎事件來自 AgentEvent:

type AgentEvent =
  // Agent lifecycle
  | { type: "agent_start" }
  | { type: "agent_end"; messages: AgentMessage[] }
  // Turn lifecycle
  | { type: "turn_start" }
  | { type: "turn_end"; message: AgentMessage; toolResults: ToolResultMessage[] }
  // Message lifecycle
  | { type: "message_start"; message: AgentMessage }
  | { type: "message_update"; message: AgentMessage; assistantMessageEvent: AssistantMessageEvent }
  | { type: "message_end"; message: AgentMessage }
  // Tool execution
  | { type: "tool_execution_start"; toolCallId: string; toolName: string; args: any }
  | { type: "tool_execution_update"; toolCallId: string; toolName: string; args: any; partialResult: any }
  | { type: "tool_execution_end"; toolCallId: string; toolName: string; result: any; isError: boolean };

來自packages/ai/src/types.ts的基本訊息：

• UserMessage（第 134 行）
• AssistantMessage（第 140 行）
• ToolResultMessage（第 152 行）

來自packages/coding-agent/src/core/messages.ts的擴充訊息：

• BashExecutionMessage（第 29 行）
• CustomMessage（第 46 行）
• BranchSummaryMessage（第 55 行）
• CompactionSummaryMessage（第 62 行）

每行都是一個 JSON 物件。第一行是工作階段標頭：

{"type":"session","version":3,"id":"uuid","timestamp":"...","cwd":"/path"}

接下來是事件發生時的情況：

{"type":"agent_start"}
{"type":"turn_start"}
{"type":"message_start","message":{"role":"assistant","content":[],...}}
{"type":"message_update","assistantMessageEvent":{"type":"text_delta","contentIndex":0,"delta":"Hello"}}
{"type":"message_end","message":{...}}
{"type":"turn_end","message":{...},"toolResults":[]}
{"type":"agent_end","messages":[...]}

message_update 記錄只包含增量。它們會省略累積的 message 欄位和 assistantMessageEvent.partial，以保持流大小線性。需要時，可以使用 contentIndex 和 delta 組合即時文字、thinking 或工具呼叫參數。message_end 包含 最終的權威訊息。

pi --mode json "List files" 2>/dev/null | jq -c 'select(.type == "message_end")'