JSON 事件流模式

pi --mode json "Your prompt"

以 JSON 行（JSONL）格式把全部会话事件输出到 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 =
  // 智能体生命周期
  | { type: "agent_start" }
  | { type: "agent_end"; messages: AgentMessage[] }
  // 回合生命周期
  | { type: "turn_start" }
  | { type: "turn_end"; message: AgentMessage; toolResults: ToolResultMessage[] }
  // 消息生命周期
  | { type: "message_start"; message: AgentMessage }
  | { type: "message_update"; message: AgentMessage; assistantMessageEvent: AssistantMessageEvent }
  | { type: "message_end"; message: AgentMessage }
  // 工具执行
  | { 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。message_end 包含最终的权威消息。

示例

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