Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help


检查点与 /rollback 功能

Hermes Agent 能在执行具有破坏性的操作之前自动为你的项目创建快照,并通过一条命令即可将其恢复。从 v2 版本起,检查点功能为可选配置——大多数用户并不会使用 /rollback 命令,而且随着时间推移,影子存储的体积也会逐渐增大,因此默认是关闭状态。

如需为每个会话启用检查点功能,可使用 --checkpoints 参数:

hermes chat --checkpoints

或通过 ~/.hermes/config.yaml 进行全局启用:

checkpoints:
  enabled: true

这一安全机制由内置的检查点管理器驱动,它会将一个共享的“影子 Git 仓库”保存在 ~/.hermes/checkpoints/store/ 目录下——您的实际项目 .git 文件永远不会被修改。Agent 处理的每个项目都会使用同一个存储空间,因此 Git 的内容寻址对象数据库能够跨项目和不同会话自动消除重复数据。

何时会生成检查点

在以下操作执行之前,系统会自动创建检查点:

  • 文件操作工具——write_filepatch
  • 具有破坏性的终端命令——rmrmdircpinstallmvsed -itruncateddshred,以及输出重定向操作(>),还有 git reset/clean/checkout

Agent 每个会话中每个目录最多只会创建一个检查点,从而避免长时间运行的会话产生大量不必要的快照。

快速参考

会话内的斜杠命令:

命令说明
/rollback列出所有检查点及其修改统计信息
/rollback <N>恢复到第 N 个检查点状态(同时撤销上一次对话内容)
/rollback diff <N>预览第 N 个检查点与当前状态之间的差异
/rollback <N> <file>从第 N 个检查点恢复单个文件

用于在会话之外查看和管理存储空间的 CLI 命令:

命令说明
hermes checkpoints显示总大小、项目数量及各项目的详细数据
hermes checkpoints status功能与直接执行 checkpoints 相同
hermes checkpoints liststatus 命令的别名
hermes checkpoints prune强制清理:删除孤立或过期的检查点,进行垃圾回收,并确保存储大小不超过限制
hermes checkpoints clear彻底清除所有检查点数据(操作前会提示确认)
hermes checkpoints clear-legacy仅删除来自 v1 迁移版本的 legacy-* 归档文件

检查点的工作原理

简而言之:

  • Hermes 能够检测到何时有工具试图修改您工作目录中的文件。
  • 在每个对话会话中(针对每个目录),它会:
    • 确定该文件的合理项目根目录。
    • 初始化或复用位于 ~/.hermes/checkpoints/store/共享影子存储空间
    • 将相关文件暂存到对应项目的索引中,构建文件结构,然后将其提交到该项目的引用路径下(refs/hermes/<project-hash>)。
  • 这些针对每个项目生成的引用便构成了检查点历史记录,您可以通过 /rollback 命令查看或恢复这些状态。
flowchart LR
  user["User command\n(hermes, gateway)"]
  agent["AIAgent\n(run_agent.py)"]
  tools["File & terminal tools"]
  cpMgr["CheckpointManager"]
  store["Shared shadow store\n~/.hermes/checkpoints/store/"]

  user --> agent
  agent -->|"tool call"| tools
  tools -->|"before mutate\nensure_checkpoint()"| cpMgr
  cpMgr -->|"git add/commit-tree/update-ref"| store
  cpMgr -->|"OK / skipped"| tools
  tools -->|"apply changes"| agent

配置

~/.hermes/config.yaml 中进行配置:

checkpoints:
  enabled: false              # master switch (default: false — opt-in)
  max_snapshots: 20           # max checkpoints per project (enforced via ref rewrite + gc)
  max_total_size_mb: 500      # hard cap on total store size; oldest commits dropped
  max_file_size_mb: 10        # skip any single file larger than this

  # Auto-maintenance (on by default): sweep ~/.hermes/checkpoints/ at startup
  # and delete project entries whose working directory no longer exists
  # (orphans) or whose last_touch is older than retention_days. Runs at most
  # once per min_interval_hours, tracked via a .last_prune marker.
  auto_prune: true
  retention_days: 7
  delete_orphans: true
  min_interval_hours: 24

如需禁用所有功能:

checkpoints:
  enabled: false
  auto_prune: false

enabled: false 时,检查点管理器将处于无效状态,不会尝试执行任何 Git 操作。而当 auto_prune: false 时,存储空间会持续扩大,直到您手动运行 hermes checkpoints prune 命令为止。

列出检查点

在 CLI 会话中:

/rollback

Hermes 会以格式化列表的形式返回变更统计信息:

📸 Checkpoints for /path/to/project:

  1. 4270a8c  2026-03-16 04:36  before patch  (1 file, +1/-0)
  2. eaf4c1f  2026-03-16 04:35  before write_file
  3. b3f9d2e  2026-03-16 04:34  before terminal: sed -i s/old/new/ config.py  (1 file, +1/-1)

  /rollback <N>             restore to checkpoint N
  /rollback diff <N>        preview changes since checkpoint N
  /rollback <N> <file>      restore a single file from checkpoint N

通过命令行查看商店状态

hermes checkpoints

示例输出:

Checkpoint base: /home/you/.hermes/checkpoints
Total size:      142.3 MB
  store/         138.1 MB
  legacy-*       4.2 MB
Projects:        12

  WORKDIR                                                       COMMITS    LAST TOUCH  STATE
  /home/you/code/hermes-agent                                        20       2h ago  live
  /home/you/code/experiments/rl-runner                                8       1d ago  live
  /home/you/code/old-prototype                                        3       9d ago  orphan
  ...

Legacy archives (1):
  legacy-20260506-050616                           4.2 MB

Clear with: hermes checkpoints clear-legacy

强制执行全面扫描(忽略24小时幂等性标记):

hermes checkpoints prune --retention-days 3 --max-size-mb 200

使用 /rollback diff 预览变更内容

在正式执行恢复操作之前,可先预览自某个检查点以来所发生的所有变更:

/rollback diff 1

此处首先显示 Git 差异统计摘要,随后才是实际的差异内容。

使用 /rollback 进行恢复

/rollback 1

在幕后,Hermes会执行以下操作:

  1. 验证目标提交记录是否存在于影子存储中。
  2. 拍摄当前状态的回滚前快照,以便日后实现“撤销撤销”操作。
  3. 恢复工作目录中已被跟踪的文件。
  4. 撤销上一次对话内容,从而使智能体的上下文与恢复后的文件系统状态保持一致。

单文件恢复

从检查点中仅恢复单个文件,而不影响目录中的其他文件:

/rollback 1 src/broken_file.py

安全与性能保护机制

  • Git 工具可用性——若 PATH 环境变量中不存在 git,则会自动禁用快照功能。
  • 目录范围限制——Hermes 会跳过过于宽泛的目录(如根目录 / 和用户主目录 $HOME)。
  • 仓库大小限制——文件数量超过 50,000 个的目录将被忽略。
  • 单文件大小上限——大小超过 max_file_size_mb(默认为 10 MB)的文件不会被纳入快照,从而避免意外存储大量数据集、模型权重或生成的媒体文件。
  • 总存储空间上限——当存储空间超过 max_total_size_mb(默认为 500 MB)时,系统会按轮询方式删除每个项目中最旧的提交记录,直至空间恢复在限制范围内。
  • 实时清理机制——通过重写各项目的引用信息并随后执行 git gc --prune=now 命令来强制实施 max_snapshots 限制,防止无用对象不断积累。
  • 无变更时跳过快照——若自上次快照生成后未发生任何更改,则该次快照生成操作将被跳过。
  • 非致命错误处理——快照管理器内部出现的所有错误都会以调试级别进行记录,同时您的工具仍可继续运行。

快照的存储位置

~/.hermes/checkpoints/
  ├── store/                 # single shared bare git repo
  │   ├── HEAD, objects/     # git internals (shared across projects)
  │   ├── refs/hermes/<hash> # per-project branch tip
  │   ├── indexes/<hash>     # per-project git index
  │   ├── projects/<hash>.json  # workdir + created_at + last_touch
  │   └── info/exclude
  ├── .last_prune            # auto-prune idempotency marker
  └── legacy-<ts>/           # archived pre-v2 per-project shadow repos

每个 <hash> 均源自工作目录的绝对路径。通常情况下无需手动修改这些值——建议使用 hermes checkpoints statuspruneclear 命令来操作。

从 v1 版本迁移

在 v2 版本重写之前,每个工作目录都会在 ~/.hermes/checkpoints/<hash>/ 下拥有一个独立的完整影子 Git 仓库。这种架构无法实现跨项目的数据去重,且其内置的清理工具实际上并无实际作用——导致存储空间会无限增长。

在首次运行 v2 版本时,所有旧版本的影子仓库都会被移至 ~/.hermes/checkpoints/legacy-<timestamp>/ 目录中,从而让新的单一存储架构在干净的状态下启动。仍可通过使用 git 手动查看该旧版归档文件来访问原有的 /rollback 回滚历史记录;一旦确认不再需要这些历史数据,即可执行相应命令进行清理:

hermes checkpoints clear-legacy

为释放存储空间,过期的归档文件也将在达到retention_days设定时间后被auto_prune功能自动清理。

最佳实践

  • 仅在需要时启用检查点 — 通过hermes chat --checkpoints命令或为特定配置文件设置enabled: true
  • 在恢复数据前使用 /rollback diff 命令 — 预览即将发生的变化,从而选择合适的检查点。
  • 若仅需撤销智能体带来的更改,请使用 /rollback 而非 git reset
  • 若频繁使用检查点,建议定期查看 hermes checkpoints status — 该命令可显示哪些项目处于活跃状态以及存储成本是多少。
  • 为确保最高安全性,可将检查点与 Git 工作树结合使用 — 将每个 Hermes 会话分别保存在独立的工作树/分支中,再以检查点作为额外保障。

关于在同一仓库中并行运行多个智能体的方法,请参阅Git 工作树指南