{/* 此页面由 website/scripts/generate-skill-docs.py 从技能的 SKILL.md 自动生成。请编辑源文件 SKILL.md,而非此页面。 */}

调试 Hermes TUI 命令

调试 Hermes TUI 斜杠命令:Python、Gateway、Ink UI。

技能元数据

来源内置(默认已安装)
路径skills/software-development/debugging-hermes-tui-commands
版本1.0.0
作者Hermes Agent
许可证MIT
平台linux, macos, windows
标签debugginghermes-agenttuislash-commandstypescriptpython
相关技能python-debugpynode-inspect-debuggersystematic-debugging

参考:完整 SKILL.md

:::info 以下是当此技能被触发时 Hermes 加载的完整技能定义。这是技能激活时代理所看到的指令。 :::

调试 Hermes TUI 斜杠命令

概述

Hermes 斜杠命令跨越三个层次——Python 命令注册表、tui_gateway JSON-RPC 桥接层和 Ink/TypeScript 前端。当命令出现异常(自动补全缺失、CLI 正常但 TUI 异常、配置已持久化但 UI 未更新)时,问题几乎总是某一层与其他层不同步所致。

当你在 Hermes TUI 中遇到斜杠命令的问题时,尤其是命令未出现在自动补全中、在 TUI 中无法正常工作,或需要添加/更新命令时,请使用此技能。

何时使用

  • 斜杠命令存在于代码库的某个部分但未能完整工作
  • 需要在后端和前端同时添加命令
  • 特定命令的自动补全功能无法正常工作
  • 命令行为在 CLI 和 TUI 之间不一致
  • 命令已持久化配置但未在 TUI 中实时生效

架构概览

Python 后端 (hermes_cli/commands.py)     <- 权威 COMMAND_REGISTRY
       │
       ▼
TUI Gateway (tui_gateway/server.py)      <- slash.exec / command.dispatch
       │
       ▼
TUI 前端 (ui-tui/src/app/slash/)         <- 本地处理器 + 降级处理

命令定义必须在 Python 和 TypeScript 中一致注册才能正常工作。Python COMMAND_REGISTRY 是以下功能的权威来源:CLI 调度、Gateway 帮助、Telegram BotCommand 菜单、Slack 子命令映射以及发送给 Ink 的自动补全数据。

调查步骤

  1. 检查命令是否存在于 TUI 前端:

    search_files --pattern "/commandname" --file_glob "*.ts" --path ui-tui/
    search_files --pattern "/commandname" --file_glob "*.tsx" --path ui-tui/
  2. 检查 TUI 命令定义:

    read_file ui-tui/src/app/slash/commands/core.ts
    # 如果不在那里:
    search_files --pattern "commandname" --path ui-tui/src/app/slash/commands --target files
  3. 检查命令是否存在于 Python 后端:

    search_files --pattern "CommandDef" --file_glob "*.py" --path hermes_cli/
    search_files --pattern "commandname" --path hermes_cli/commands.py --context 3
  4. 检查 Gateway 实现:

    search_files --pattern "complete.slash|slash.exec" --path tui_gateway/

修复:缺失的命令自动补全

如果命令存在于 TUI 但未出现在自动补全中:

  1. hermes_cli/commands.pyCOMMAND_REGISTRY 中添加 CommandDef 条目:

    CommandDef("commandname", "命令的描述", "Session",
               cli_only=True, aliases=("alias",),
               args_hint="[arg1|arg2|arg3]",
               subcommands=("arg1", "arg2", "arg3")),
  2. 仔细选择 cli_only 与 Gateway 可用性:

    • cli_only=True — 仅在交互式 CLI/TUI 中可用
    • gateway_only=True — 仅在消息平台中可用
    • 两者均不设置 — 随处可用
    • gateway_config_gate="display.foo" — 在 Gateway 中按配置门控可用性
  3. 确保 subcommands 与 TUI 显示的预期 Tab 补全选项一致。

  4. 如果命令在服务端运行,在 cli.pyHermesCLI.process_command() 中添加处理器:

    elif canonical == "commandname":
        self._handle_commandname(cmd_original)
  5. 对于 Gateway 可用的命令,在 gateway/run.py 中添加处理器:

    if canonical == "commandname":
        return await self._handle_commandname(event)

常见问题

  1. 命令在 TUI 中显示但不在自动补全中。 命令在 TUI 代码库中已定义,但 hermes_cli/commands.pyCOMMAND_REGISTRY 中缺失。自动补全数据来自 Python。

  2. 命令在自动补全中显示但无法工作。 检查 tui_gateway/server.py 中的命令处理器和 ui-tui/src/app/createSlashHandler.ts 中的前端处理器。如果命令是 Ink 本地命令,必须在 app.tsx 内置分支中处理;否则会降级到 slash.exec 并需要有 Python 处理器。

  3. 命令行为在 CLI 和 TUI 之间不同。 命令可能有不同的实现。同时检查 cli.py::process_command 和 TUI 的本地处理器。本地 TUI 处理器的优先级高于 Gateway 调度。

  4. 命令持久化了配置但未实时生效。 对于 TUI 本地命令,仅 config.set 是不够的。还需立即更新相关的 nanostore 状态(通常使用 patchUiState(...))并将新状态传递给渲染组件。例如:/details collapsed 必须实时更新详情可见性,而不仅仅是保存 details_mode;会话中的全局 /details <mode> 可能需要独立的命令覆盖标志,以便实时命令可以覆盖内置的区块默认值,同时启动/配置同步保留默认展开的思考/工具行为。

  5. Gateway 调度静默忽略命令。 Gateway 只调度它知道的命令。检查 GATEWAY_KNOWN_COMMANDS(从 COMMAND_REGISTRY 自动衍生)是否包含规范名称。如果命令是 cli_only 并带有 gateway_config_gate,请验证门控配置值为真。

调试策略

当表面检查无法揭示问题时:

  • Python 端挂起或异常: 使用 python-debugpy 技能在 _SlashWorker.exec 或命令处理器内部设断点。在处理器入口设置 remote-pdb 是最快的方法。
  • Ink 端无响应: 使用 node-inspect-debugger 技能在 app.tsx 的斜杠调度或本地命令分支中设断点。npm run build 后使用 sb('dist/app.js', <line>)
  • 注册表不匹配/不确定哪一侧有问题: 并排比较规范的 COMMAND_REGISTRY 条目与 TUI 的本地命令列表。

注意事项

  • 不要忘记在 CommandDef 中为命令设置适当的分类(例如 “Session”、“Configuration”、“Tools & Skills”、“Info”、“Exit”)
  • 确保所有别名都正确注册在 aliases 元组中——无需修改其他文件,所有下游功能(Telegram 菜单、Slack 映射、自动补全、帮助信息)均由此衍生
  • 对于带有子命令的命令,确保 CommandDef 中的 subcommands 元组与 TUI 代码中的一致
  • cli_only=True 的命令在 Gateway/消息平台中无法工作——除非添加 gateway_config_gate 且门控值为真
  • 添加实时 UI 状态后,搜索所有使用旧 prop/helper 的地方,将新状态通过所有渲染路径传递,而不仅仅是活跃的流式路径。TUI 详情渲染至少有两条重要路径:实时 StreamingAssistant/ToolTrail 和转录/待处理 MessageLine 行。/clean 操作应明确检查两者。
  • 在测试前重新构建 TUI(npm --prefix ui-tui run build)——tsx 监视模式可能在首次启动时有延迟

验证

修复后:

  1. 重新构建 TUI:

    cd /home/bb/hermes-agent && npm --prefix ui-tui run build
  2. 运行 TUI 并测试命令:

    hermes --tui
  3. 输入 / 并验证命令出现在自动补全建议中,带有预期的描述和参数提示。

  4. 执行命令并确认:

    • 预期行为正常触发
    • 持久化配置正确更新(read_file ~/.hermes/config.yaml
    • 实时 UI 状态立即反映更改(而不仅限于重启后)
  5. 如果命令也适用于 Gateway,至少从一个消息平台测试(或运行 Gateway 测试:scripts/run_tests.sh tests/gateway/)。