SuperAPI AI 工具集

vhs-terminal-recorder

通用与其它

查看项目

更新于 10-16 07:17

技能介绍

用途:当用户点名 Charmbracelet VHS、vhs CLI、.tape、终端 GIF、终端录制、命令行 screencast 或脚本化终端演示,或文档需要 CLI 行为的可复现录像,或已有 VHS tape 需要编写、验证、渲染、调试时使用。不用于任意桌面捕获、浏览器产品导览、视频剪辑或无法确定化的一次性交互工作。

主要能力:VHS 在伪终端中运行 tape 文件并把会话渲染为 GIF、MP4 或 WebM;支持 vhs validate 检查语法、vhs themes 查看主题、vhs record 录制、vhs publish 发布 GIF 到 vhs.charm.sh,以及 Screenshot、Source、Copy、Paste、Env 等命令。

使用方式:先验证本地环境,命令保持原样:vhs --version、vhs --help;按需查看 vhs record --help、vhs validate --help、vhs publish --help;缺少时可 brew install vhs,其他平台按上游安装说明。编写 tape 时在文件顶部设置 Output、Require 及大部分 Set;显式设置 Output、Set Shell、Width、Height、FontSize、TypingSpeed、Theme;为每个外部命令添加 Require;用 Hide/Show 隐藏准备步骤;等待就绪用 Wait+Screen@<timeout> /pattern/ 或 Wait@<timeout>,Sleep 仅用于演示节奏。验证与渲染:vhs validate docs/demo.tape、vhs docs/demo.tape。多文件验证需给 glob 加引号:vhs validate 'docs/*.tape'。输出格式由 Output 决定,如 Output demo.gif、Output demo.mp4、Output demo.webm、Output frames/ 或 Output golden.ascii。

适用场景:为文档或 README 生成轻量 GIF、生成高质量 MP4/WebM、需要 PNG 序列后期处理、集成测试 golden 文件、调试失败 tape(先验证,再在干净 shell 或临时目录中直接运行展示命令)。

限制:vhs validate 只检查语法,不运行 Require 检查,也不证明演示命令成功;渲染会执行 tape,可能修改文件、访问网络或运行项目命令,运行不受信任 tape 前应先阅读;不要捕获或发布密钥、令牌、真实客户数据、私有路径、.env、shell 历史等;vhs publish 有外部副作用,需用户明确批准后才能发布指定文件;渲染依赖本地 VHS 渲染栈,尤其是 ttyd 和 ffmpeg;首次渲染可能因初始化缓存较慢;主题名不要凭记忆猜测,应通过 vhs themes 获取;不要随意提交生成的视频文件。官方安装、精确语法和更多命令请查阅上游资料。