Skip to main content

JSON 事件流模式

pi --mode json "Your prompt"

将所有会话事件以 JSON 行输出到 stdout，用于将 Pi 集成到其他工具或自定义 UI。

事件类型​

type AgentSessionEvent =
  | AgentEvent
  | { type: "auto_compaction_start"; reason: "threshold" | "overflow" }
  | { type: "auto_compaction_end"; result: CompactionResult }
  | { type: "auto_retry_start"; attempt: number }
  | { type: "auto_retry_end"; success: boolean };

基础事件：

type AgentEvent =
  | { type: "agent_start" }
  | { type: "agent_end"; messages: AgentMessage[] }
  | { type: "turn_start" }
  | { type: "turn_end" }
  | { type: "message_start"; message: AgentMessage }
  | { type: "message_end"; message: AgentMessage }
  | { type: "message_update"; ... }
  | { type: "tool_execution_start"; ... }
  | { type: "tool_execution_end"; ... };

翻译自 pi-coding-agent/docs/json.md