用途:在 Neovim 中引导一次可见且经过验证的代码走查,先确认真实代码与输出,再通过一份不可变的 Navi 导览引导注意力。
准备:确认已安装 termctrl、Neovim 0.10 或更新版本以及 navi.nvim。在项目根目录以可见前台会话启动 Neovim:termctrl run walkthrough -- nvim。从另一进程用 Terminal Control 检查并驱动同一会话,优先使用 Terminal Control MCP 的 interact,否则用 termctrl show、termctrl send、termctrl wait。终端过窄时先调整尺寸,演示或录制期间保持尺寸稳定。
建立旅程:先明确观众应理解或能解释的内容,阅读相关代码并运行能证明其当前行为的最小命令,检查实际可见结果,不要凭预期或记忆写笔记。选择一条概念性旅程,通常从公开行为到产生它的机制,再到观察到的结果。不要将概览、故障诊断、实现导览和修复合并为一个序列。
编写导览:临时导览可创建在源码树之外的 JSON 文件,使用唯一稳定的字面模式,仅在精确位置是重点时用行号。用 :NaviLoad /absolute/path/to/tour.json 加载且不修改。每次回复最多创建一份导览,已展示的导览视为不可变,同一回复中不得重写其停靠点或笔记。从行为或调用点开始,再进入实现细节。
演示:默认由观众控制节奏,]n 下一站、[n 上一站、<leader>np 选择、<leader>nc 清除(推荐映射,非 Navi 默认;不可用时用 :NaviNext、:NaviPrev、:NaviPick、:NaviClear)。
录制:需要面向人的演示时用 OBS,为终端窗口添加 Window Capture 源,录制前裁剪无关内容并测试可读性。需要终端原生回放或调试证据时用 Terminal Control:termctrl save walkthrough --format png --out artifacts/current 截图;录制须在会话启动时启用,可用 termctrl run walkthrough --record artifacts/walkthrough.termctrl -- nvim 重启,配合 termctrl mark、termctrl markers、termctrl video 导出。除非用户明确需要,不要录制或保留可能含密钥的输入、源码、路径或输出。
结束::NaviClear 清除导览,termctrl stop walkthrough 停止会话,并报告已验证行为、所展示旅程及保留的产物路径。
限制:录制无法添加到已运行的前台会话;OBS 与 Terminal Control 的产物用途不同。工具参考:Terminal Control https://github.com/anomalyco/terminal-control,Navi https://github.com/kitlangton/navi.nvim。