JSON 事件流模式
创建于 2025-07-16·更新于 2026-07-16
pi --mode json "Your prompt"将所有会话事件以 JSON 行（JSON Lines）格式输出到标准输出。适用于将 pi 集成到其他工具或自定义 UI 中。
事件类型 Event Types
事件定义于 AgentSessionEvent：
type AgentSessionEvent =
| AgentEvent
| { type: "queue_update"; steering: readonly string[]; followUp: readonly string[] }
| { type: "compaction_start"; reason: "manual" | "threshold" | "overflow" }
| { type: "compaction_end"; reason: "manual" | "threshold" | "overflow"; result: CompactionResult | undefined; aborted: boolean; willRetry: boolean; errorMessage?: string }
| { type: "auto_retry_start"; attempt: number; maxAttempts: number; delayMs: number; errorMessage: string }
| { type: "auto_retry_end"; success: boolean; attempt: number; finalError?: string };queue_update 在待处理队列（steering）和后续操作队列（follow-up）发生变化时，发送完整的队列内容。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 };消息类型 Message Types
基础消息来自 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 行）
输出格式 Output Format
每一行是一个 JSON 对象。第一行是会话头（session header）：
{"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","message":{...},"assistantMessageEvent":{"type":"text_delta","delta":"Hello",...}}
{"type":"message_end","message":{...}}
{"type":"turn_end","message":{...},"toolResults":[]}
{"type":"agent_end","messages":[...]}示例 Example
pi --mode json "List files" 2>/dev/null | jq -c 'select(.type == "message_end")'