会话格式 – 数字花园

会话格式

创建于 2025-07-16·更新于 2026-07-16

会话以 JSONL（JSON Lines）文件形式存储。每行是一个包含 type 字段的 JSON 对象。会话条目通过 id/parentId 字段形成树状结构，支持原地分支操作而无需创建新文件。

文件位置 File Location

~/.pi/agent/sessions/--<path>--/<timestamp>_<uuid>.jsonl

其中 <path> 为工作目录，路径中的 / 替换为 -。

删除会话 Deleting Sessions

可通过删除 ~/.pi/agent/sessions/ 下的 .jsonl 文件来移除会话。

Pi 也支持从 /resume 交互式删除（选择会话后按 Ctrl+D，然后确认）。如果可用，pi 会使用 trash 命令行工具以避免永久删除。

会话版本 Session Version

会话在 header 中包含一个版本字段：

版本 1 Version 1：线性条目序列（旧版，加载时自动迁移）
版本 2 Version 2：使用 id/parentId 关联的树状结构
版本 3 Version 3：将 hookMessage 角色重命名为 custom（扩展统一）

现有会话在加载时会自动迁移到当前版本（v3）。

源代码 Source Files

GitHub 源码（pi-mono）：

packages/coding-agent/src/core/session-manager.ts - 会话条目类型与 SessionManager
packages/coding-agent/src/core/messages.ts - 扩展消息类型（BashExecutionMessage、CustomMessage 等）
packages/ai/src/types.ts - 基础消息类型（UserMessage、AssistantMessage、ToolResultMessage）
packages/agent/src/types.ts - AgentMessage 联合类型

如需项目中的 TypeScript 定义，请查看 node_modules/@earendil-works/pi-coding-agent/dist/ 和 node_modules/@earendil-works/pi-ai/dist/。

消息类型 Message Types

会话条目包含 AgentMessage 对象。理解这些类型对于解析会话和编写扩展至关重要。

内容块 Content Blocks

消息包含类型化内容块的数组：

interface TextContent {
  type: "text";
  text: string;
}

interface ImageContent {
  type: "image";
  data: string;      // base64 编码
  mimeType: string;  // 例如 "image/jpeg"、"image/png"
}

interface ThinkingContent {
  type: "thinking";
  thinking: string;
}

interface ToolCall {
  type: "toolCall";
  id: string;
  name: string;
  arguments: Record<string, any>;
}

基础消息类型（来自 pi-ai）Base Message Types

interface UserMessage {
  role: "user";
  content: string | (TextContent | ImageContent)[];
  timestamp: number;  // Unix 毫秒
}

interface AssistantMessage {
  role: "assistant";
  content: (TextContent | ThinkingContent | ToolCall)[];
  api: string;
  provider: string;
  model: string;
  usage: Usage;
  stopReason: "stop" | "length" | "toolUse" | "error" | "aborted";
  errorMessage?: string;
  timestamp: number;
}

interface ToolResultMessage {
  role: "toolResult";
  toolCallId: string;
  toolName: string;
  content: (TextContent | ImageContent)[];
  details?: any;      // 工具特定元数据
  isError: boolean;
  timestamp: number;
}

interface Usage {
  input: number;
  output: number;
  cacheRead: number;
  cacheWrite: number;
  totalTokens: number;
  cost: {
    input: number;
    output: number;
    cacheRead: number;
    cacheWrite: number;
    total: number;
  };
}

扩展消息类型（来自 pi-coding-agent）Extended Message Types

interface BashExecutionMessage {
  role: "bashExecution";
  command: string;
  output: string;
  exitCode: number | undefined;
  cancelled: boolean;
  truncated: boolean;
  fullOutputPath?: string;
  excludeFromContext?: boolean;  // 使用 !! 前缀命令时为 true
  timestamp: number;
}

interface CustomMessage {
  role: "custom";
  customType: string;            // 扩展标识符
  content: string | (TextContent | ImageContent)[];
  display: boolean;              // 在 TUI 中显示
  details?: any;                 // 扩展特定元数据
  timestamp: number;
}

interface BranchSummaryMessage {
  role: "branchSummary";
  summary: string;
  fromId: string;                // 分支来源的条目
  timestamp: number;
}

interface CompactionSummaryMessage {
  role: "compactionSummary";
  summary: string;
  tokensBefore: number;
  timestamp: number;
}

AgentMessage 联合类型 AgentMessage Union

type AgentMessage =
  | UserMessage
  | AssistantMessage
  | ToolResultMessage
  | BashExecutionMessage
  | CustomMessage
  | BranchSummaryMessage
  | CompactionSummaryMessage;

条目基础 Entry Base

所有条目（SessionHeader 除外）都扩展自 SessionEntryBase：

interface SessionEntryBase {
  type: string;
  id: string;           // 8 字符十六进制 ID
  parentId: string | null;  // 父条目 ID（第一个条目为 null）
  timestamp: string;    // ISO 时间戳
}

条目类型 Entry Types

SessionHeader

文件的第一行。仅包含元数据，不属于树结构（无 id/parentId）。

{"type":"session","version":3,"id":"uuid","timestamp":"2024-12-03T14:00:00.000Z","cwd":"/path/to/project"}

具有父会话的会话（通过 /fork、/clone 或 newSession({ parentSession }) 创建）：

{"type":"session","version":3,"id":"uuid","timestamp":"2024-12-03T14:00:00.000Z","cwd":"/path/to/project","parentSession":"/path/to/original/session.jsonl"}

SessionMessageEntry

对话中的一条消息。message 字段包含一个 AgentMessage。

{"type":"message","id":"a1b2c3d4","parentId":"prev1234","timestamp":"2024-12-03T14:00:01.000Z","message":{"role":"user","content":"Hello"}}
{"type":"message","id":"b2c3d4e5","parentId":"a1b2c3d4","timestamp":"2024-12-03T14:00:02.000Z","message":{"role":"assistant","content":[{"type":"text","text":"Hi!"}],"provider":"anthropic","model":"claude-sonnet-4-5","usage":{...},"stopReason":"stop"}}
{"type":"message","id":"c3d4e5f6","parentId":"b2c3d4e5","timestamp":"2024-12-03T14:00:03.000Z","message":{"role":"toolResult","toolCallId":"call_123","toolName":"bash","content":[{"type":"text","text":"output"}],"isError":false}}

ModelChangeEntry

当用户在会话中切换模型时生成。

{"type":"model_change","id":"d4e5f6g7","parentId":"c3d4e5f6","timestamp":"2024-12-03T14:05:00.000Z","provider":"openai","modelId":"gpt-4o"}

ThinkingLevelChangeEntry

当用户更改思考/推理级别时生成。

{"type":"thinking_level_change","id":"e5f6g7h8","parentId":"d4e5f6g7","timestamp":"2024-12-03T14:06:00.000Z","thinkingLevel":"high"}

CompactionEntry

当上下文被压缩时创建。存储之前消息的摘要。

{"type":"compaction","id":"f6g7h8i9","parentId":"e5f6g7h8","timestamp":"2024-12-03T14:10:00.000Z","summary":"用户讨论了 X、Y、Z...","firstKeptEntryId":"c3d4e5f6","tokensBefore":50000}

可选字段：

details：实现特定数据（例如默认的 { readFiles: string[], modifiedFiles: string[] }，或扩展的自定义数据）
fromHook：如果由扩展生成则为 true，如果由 pi 生成则为 false/undefined（旧字段名称）

BranchSummaryEntry

通过 /tree 切换分支时创建，包含由 LLM 生成的、从分支点至共同祖先的左侧分支摘要。用于捕获被放弃路径上的上下文。

{"type":"branch_summary","id":"g7h8i9j0","parentId":"a1b2c3d4","timestamp":"2024-12-03T14:15:00.000Z","fromId":"f6g7h8i9","summary":"分支探索了方案 A..."}

可选字段：

details：默认的文件追踪数据（{ readFiles: string[], modifiedFiles: string[] }），或扩展的自定义数据
fromHook：如果由扩展生成则为 true，如果由 pi 生成则为 false/undefined（旧字段名称）

CustomEntry

扩展状态持久化。不参与 LLM 上下文。

{"type":"custom","id":"h8i9j0k1","parentId":"g7h8i9j0","timestamp":"2024-12-03T14:20:00.000Z","customType":"my-extension","data":{"count":42}}

使用 customType 来标识你的扩展条目，以便重新加载时识别。交互模式可通过 pi.registerEntryRenderer(customType, renderer) 渲染自定义条目，但它们仍然不参与 LLM 上下文。

CustomMessageEntry

扩展注入的消息，会参与 LLM 上下文。

{"type":"custom_message","id":"i9j0k1l2","parentId":"h8i9j0k1","timestamp":"2024-12-03T14:25:00.000Z","customType":"my-extension","content":"注入的上下文...","display":true}

字段：

content：字符串或 (TextContent | ImageContent)[]（与 UserMessage 相同）
display：true = 在 TUI 中以独特样式显示，false = 隐藏
details：可选的扩展特定元数据（不发送给 LLM）

LabelEntry

用户在条目上定义的书签/标记。

{"type":"label","id":"j0k1l2m3","parentId":"i9j0k1l2","timestamp":"2024-12-03T14:30:00.000Z","targetId":"a1b2c3d4","label":"checkpoint-1"}

将 label 设为 undefined 可清除标签。

SessionInfoEntry

会话元数据（例如用户定义的显示名称）。可通过 /name、--name / -n 或扩展中的 pi.setSessionName() 设置。

{"type":"session_info","id":"k1l2m3n4","parentId":"j0k1l2m3","timestamp":"2024-12-03T14:35:00.000Z","name":"重构认证模块 Refactor auth module"}

会话名称设置后，将在会话选择器（/resume）中替代第一条消息显示。

树形结构 Tree Structure

条目形成一棵树：

第一条条目的 parentId: null
后续每条条目通过 parentId 指向其父条目
分支操作从较早的条目创建新的子条目
“叶节点"是树中的当前位置

[用户消息] ─── [助手] ─── [用户消息] ─── [助手] ─┬─ [用户消息] ← 当前叶节点
                                                │
                                                └─ [分支摘要] ─── [用户消息] ← 替代分支

上下文构建 Context Building

buildContextEntries() 从当前叶节点向根节点遍历，生成活动条目列表，同时处理压缩逻辑：

收集路径上的所有条目
如果路径上存在 CompactionEntry：
- 先包含压缩条目本身
- 然后包含从 firstKeptEntryId 到压缩条目的条目
- 最后包含压缩条目之后的条目
保留选定范围内的非消息条目，以便交互模式可以渲染它们

buildSessionContext() 在该条目列表的基础上构建发送给 LLM 的消息列表：

从完整路径中提取当前模型和思考级别设置
将选定的条目转换为消息：
- message -> 存储的 AgentMessage
- compaction -> compactionSummary
- branch_summary -> branchSummary
- custom_message -> CustomMessage
- custom -> 不生成上下文消息

解析示例 Parsing Example

import { readFileSync } from "fs";

const lines = readFileSync("session.jsonl", "utf8").trim().split("\n");

for (const line of lines) {
  const entry = JSON.parse(line);

  switch (entry.type) {
    case "session":
      console.log(`Session v${entry.version ?? 1}: ${entry.id}`);
      break;
    case "message":
      console.log(`[${entry.id}] ${entry.message.role}: ${JSON.stringify(entry.message.content)}`);
      break;
    case "compaction":
      console.log(`[${entry.id}] Compaction: ${entry.tokensBefore} tokens summarized`);
      break;
    case "branch_summary":
      console.log(`[${entry.id}] Branch from ${entry.fromId}`);
      break;
    case "custom":
      console.log(`[${entry.id}] Custom (${entry.customType}): ${JSON.stringify(entry.data)}`);
      break;
    case "custom_message":
      console.log(`[${entry.id}] Extension message (${entry.customType}): ${entry.content}`);
      break;
    case "label":
      console.log(`[${entry.id}] Label "${entry.label}" on ${entry.targetId}`);
      break;
    case "model_change":
      console.log(`[${entry.id}] Model: ${entry.provider}/${entry.modelId}`);
      break;
    case "thinking_level_change":
      console.log(`[${entry.id}] Thinking: ${entry.thinkingLevel}`);
      break;
  }
}

SessionManager API

编程操作会话的关键方法。

静态创建方法 Static Creation Methods

SessionManager.create(cwd, sessionDir?) - 新建会话
SessionManager.open(path, sessionDir?) - 打开现有会话文件
SessionManager.continueRecent(cwd, sessionDir?) - 继续最近的会话，或创建新会话
SessionManager.inMemory(cwd?) - 不持久化到文件
SessionManager.forkFrom(sourcePath, targetCwd, sessionDir?) - 从其他项目分支会话

静态列表方法 Static Listing Methods

SessionManager.list(cwd, sessionDir?, onProgress?) - 列出某个目录的会话
SessionManager.listAll(onProgress?) - 列出所有项目中的所有会话

实例方法 - 会话管理 Instance Methods - Session Management

newSession(options?) - 启动新会话（选项：{ parentSession?: string }）
setSessionFile(path) - 切换到不同的会话文件
createBranchedSession(leafId) - 将分支提取到新会话文件

实例方法 - 追加（均返回条目 ID） Instance Methods - Appending

appendMessage(message) - 添加消息
appendThinkingLevelChange(level) - 记录思考级别更改
appendModelChange(provider, modelId) - 记录模型更改
appendCompaction(summary, firstKeptEntryId, tokensBefore, details?, fromHook?) - 添加压缩
appendCustomEntry(customType, data?) - 扩展状态（不在上下文中）
appendSessionInfo(name) - 设置会话显示名称
appendCustomMessageEntry(customType, content, display, details?) - 扩展消息（在上下文中）
appendLabelChange(targetId, label) - 设置/清除标签

实例方法 - 树导航 Instance Methods - Tree Navigation

getLeafId() - 获取当前位置
getLeafEntry() - 获取当前叶节点条目
getEntry(id) - 按 ID 获取条目
getBranch(fromId?) - 从条目遍历到根节点
getTree() - 获取完整树结构
getChildren(parentId) - 获取直接子节点
getLabel(id) - 获取条目的标签
branch(entryId) - 将叶节点移动到较早的条目
resetLeaf() - 将叶节点重置为 null（在任何条目之前）
branchWithSummary(entryId, summary, details?, fromHook?) - 带上下文摘要的分支

实例方法 - 上下文与信息 Instance Methods - Context & Info

buildContextEntries() - 获取应用了压缩的活动分支条目
buildSessionContext() - 获取供 LLM 使用的消息、thinkingLevel 和 model
getEntries() - 所有条目（不包含 header）
getHeader() - 会话 header 元数据
getSessionName() - 从最新的 session_info 条目获取显示名称
getCwd() - 工作目录
getSessionDir() - 会话存储目录
getSessionId() - 会话 UUID
getSessionFile() - 会话文件路径（内存模式为 undefined）
isPersisted() - 会话是否已保存到磁盘