vcr-tui
一个用于预览VCR测试数据和机器生成文件的终端用户界面工具。
安装使用
复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:
帮我安装这个 AI Skill:vcr-tui。 它的用途是:一个用于预览VCR测试数据和机器生成文件的终端用户界面工具。 完整的 Skill 内容见:https://321skill.com/skills/vcr-tui/raw/index.md 请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
“帮我启动VCR-TUI,查看`./spec/cassettes`目录下的录制文件。”,AI会引导你执行相应命令,启动一个终端界面,让你可以直观地浏览和搜索所有测试录制文件。当你在调试一个失败的API测试时,可以
对AI说:“我想看`user_login.yaml`文件中第一个交互的响应体是什么。”,AI会指导你使用`vcr-tui preview`命令并指定key路径,快速定位到具体的响应内容进行比对分析。
介绍
VCR-TUI是一款专为开发者设计的终端用户界面工具,它解决了在开发过程中,尤其是在编写和调试涉及HTTP交互的测试时,需要频繁查看和解析VCR录制的YAML格式测试数据文件(cassettes)的痛点。这些文件通常结构复杂、内容冗长,在普通编辑器中难以直观浏览。
用户可以通过简单的命令行启动TUI,在交互式界面中浏览指定目录下的所有VCR文件列表,并直接预览其内容。工具支持在文件列表和内容预览面板之间切换焦点,并允许用户深入查看文件中的特定键值,例如某个特定交互的请求或响应体,极大地提升了查阅效率。
它非常适合需要处理API测试、网络请求录制回放场景的开发者,特别是后端开发、测试工程师以及全栈开发人员。这些角色经常需要验证测试数据的正确性,或者调试因网络请求/响应不匹配而导致的问题。
使用建议:建议在本地开发或测试环境中使用。由于它直接读取本地YAML文件,请确保文件路径正确,并注意工具主要提供预览功能,不直接编辑文件。对于超大型文件,预览时可能需要一些加载时间。
核心特点
与直接使用文本编辑器或命令行工具(如cat, jq)查看YAML文件相比,VCR-TUI提供了专为VCR文件结构优化的交互式TUI界面,能够以更清晰、可导航的方式展示嵌套的请求/响应数据,并支持直接定位到具体的交互索引和键路径,无需手动解析复杂结构。
注意事项
该工具主要用于预览和浏览,不支持编辑或修改VCR文件内容,也不适用于非YAML格式或非VCR标准结构的文件。
常见问题
VCR-TUI能编辑cassette文件吗?
不能,它只是一个用于预览和浏览VCR录制文件的只读工具。
除了VCR文件,它能看其他YAML文件吗?
可以加载任何YAML文件,但界面和导航优化是针对VCR文件结构设计的,对其他YAML文件的展示可能不够友好。
给 AI 助手的安装指引
如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:
请访问 https://321skill.com/skills/vcr-tui/raw/index.md 读取 vcr-tui 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址:/skills/vcr-tui/raw/index.md(查看排版版本)