跳到主要内容

扩展 CLI

Hermes 在 HermesCLI 上暴露受保护的扩展钩子，使包装 CLI 可以添加小部件、按键绑定和布局自定义，而无需覆盖 1000+ 行的 run() 方法。这使你的扩展与内部变化解耦。

扩展点​

有五个扩展缝隙可用：

钩子用途覆盖时机...
_get_extra_tui_widgets()将小部件注入布局你需要一个持久 UI 元素（面板、状态栏、迷你播放器）
_register_extra_tui_keybindings(kb, *, input_area)添加键盘快捷键你需要热键（切换面板、传输控制、模态快捷键）
_build_tui_layout_children(**widgets)完全控制小部件排序你需要重新排序或包装现有小部件（很少见）
process_command()添加自定义斜杠命令你需要 /mycommand 处理（已存在的钩子）
_build_tui_style_dict()自定义 prompt_toolkit 样式你需要自定义颜色或样式（已存在的钩子）

前三个是新受保护钩子。后两个已存在。

快速开始：包装 CLI​

#!/usr/bin/env python3
"""my_cli.py — 扩展 Hermes 的示例包装 CLI。"""

from cli import HermesCLI
from prompt_toolkit.layout import FormattedTextControl, Window
from prompt_toolkit.filters import Condition


class MyCLI(HermesCLI):

    def __init__(self, **kwargs):
        super().__init__(**kwargs)
        self._panel_visible = False

    def _get_extra_tui_widgets(self):
        """在状态栏上方添加可切换的信息面板。"""
        cli_ref = self
        return [
            Window(
                FormattedTextControl(lambda: "📊 My custom panel content"),
                height=1,
                filter=Condition(lambda: cli_ref._panel_visible),
            ),
        ]

    def _register_extra_tui_keybindings(self, kb, *, input_area):
        """F2 切换自定义面板。"""
        cli_ref = self

        @kb.add("f2")
        def _toggle_panel(event):
            cli_ref._panel_visible = not cli_ref._panel_visible

    def process_command(self, cmd: str) -> bool:
        """添加 /panel 斜杠命令。"""
        if cmd.strip().lower() == "/panel":
            self._panel_visible = not self._panel_visible
            state = "visible" if self._panel_visible else "hidden"
            print(f"Panel is now {state}")
            return True
        return super().process_command(cmd)


if __name__ == "__main__":
    cli = MyCLI()
    cli.run()

运行它：

cd ~/.hermes/hermes-agent
source .venv/bin/activate
python my_cli.py

钩子参考​

_get_extra_tui_widgets()​

返回要插入 TUI 布局的 prompt_toolkit 小部件列表。小部件出现在占位符和状态栏之间 — 在输入区域下方但在主输出上方。

def _get_extra_tui_widgets(self) -> list:
    return []  # 默认：无额外小部件

每个小部件应该是 prompt_toolkit 容器（例如 Window、ConditionalContainer、HSplit）。使用 ConditionalContainer 或 filter=Condition(...) 使小部件可切换。

from prompt_toolkit.layout import ConditionalContainer, Window, FormattedTextControl
from prompt_toolkit.filters import Condition

def _get_extra_tui_widgets(self):
    return [
        ConditionalContainer(
            Window(FormattedTextControl("Status: connected"), height=1),
            filter=Condition(lambda: self._show_status),
        ),
    ]

_register_extra_tui_keybindings(kb, *, input_area)​

在 Hermes 注册自己的按键绑定之后、布局构建之前调用。将你的按键绑定添加到 kb。

def _register_extra_tui_keybindings(self, kb, *, input_area):
    pass  # 默认：无额外按键绑定

参数：

  • kb — prompt_toolkit 应用程序的 KeyBindings 实例
  • input_area — 主 TextArea 小部件，如果你需要读取或操作用户输入
def _register_extra_tui_keybindings(self, kb, *, input_area):
    cli_ref = self

    @kb.add("f3")
    def _clear_input(event):
        input_area.text = ""

    @kb.add("f4")
    def _insert_template(event):
        input_area.text = "/search "

避免与内置按键绑定冲突：Enter（提交）、Escape Enter（换行）、Ctrl-C（中断）、Ctrl-D（退出）、Tab（自动建议接受）。F2+ 和 Ctrl 组合键通常是安全的。

_build_tui_layout_children(**widgets)​

仅当你需要完全控制小部件排序时才覆盖。大多数扩展应改用 _get_extra_tui_widgets()。

def _build_tui_layout_children(self, *, sudo_widget, secret_widget,
    approval_widget, clarify_widget, spinner_widget, spacer,
    status_bar, input_rule_top, image_bar, input_area,
    input_rule_bot, voice_status_bar, completions_menu) -> list:

默认实现返回：

[
    Window(height=0),       # 锚点
    sudo_widget,            # sudo 密码提示（条件）
    secret_widget,          # 密钥输入提示（条件）
    approval_widget,        # 危险命令审批（条件）
    clarify_widget,         # 澄清问题 UI（条件）
    spinner_widget,         # 思考旋转器（条件）
    spacer,                 # 填充剩余垂直空间
    *self._get_extra_tui_widgets(),  # 你小部件的位置
    status_bar,             # 模型/token/上下文状态行
    input_rule_top,         # 输入上方边框
    image_bar,              # 附加图像计数
    input_area,             # 用户文本输入
    input_rule_bot,         # 输入下方边框
    voice_status_bar,       # 语音模式状态（条件）
    completions_menu,       # 自动完成下拉菜单
]

布局图​

从上到下的默认布局：

  1. 输出区域 — 滚动对话历史
  2. 占位符
  3. 额外小部件 — 来自 _get_extra_tui_widgets()
  4. 状态栏 — 模型、上下文%、已用时间
  5. 图像栏 — 附加图像计数
  6. 输入区域 — 用户提示
  7. 语音状态 — 录音指示器
  8. 补全菜单 — 自动完成建议

技巧​

  • 状态改变后使显示失效：调用 self._invalidate() 触发 prompt_toolkit 重绘。
  • 访问 agent 状态：self.agent、self.model、self.conversation_history 都可用。
  • 自定义样式：覆盖 _build_tui_style_dict() 并为你自定义样式类添加条目。
  • 斜杠命令：覆盖 process_command()，处理你的命令，并为其他所有内容调用 super().process_command(cmd)。
  • 不要覆盖 run() 除非绝对必要 — 扩展钩子的存在正是为了避免这种耦合。