关于 vhs-recording
vhs-recording 是一项用于制作终端录屏的技能,面向需要为文档创建终端演示的人。它通过检查 VHS tape 文件并执行录制,生成 GIF。
主要功能
- 01检查并验证 tape 文件
- 02检查 VHS 安装状态
- 03执行终端录制
- 04确认 GIF 输出文件
适用场景
- 01为文档制作终端演示 GIF
- 02按 tape 脚本录制终端会话
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ athola/ claude-night-market --skill vhs-recording安装后在 Claude Code 中输入/vhs-recording确认已加载。
附带文件modules/execution.mdmodules/tape-syntax.md
详细介绍
VHS 录制技能
根据 VHS tape 文件生成专业的终端录制内容。
适用场景
- 使用 VHS tape 脚本录制终端会话
- 为文档创建终端演示录制内容
不适用场景
- 基于浏览器的工作流——改用 scry:browser-recording
- 非终端演示或 GUI 应用程序
概述
VHS 会将声明式 tape 文件转换为终端会话的动画 GIF。Tape 文件用于定义命令、时间安排和终端外观。
必需的进度项
- Locate and validate tape file
- Check VHS installation status
- Execute VHS recording
- Verify output GIF creation
模块参考
- 查看
modules/tape-syntax.md,了解 VHS tape 文件指令 - 查看
modules/execution.md,了解录制工作流详情
工作流
阶段 1:验证 Tape 文件
- 确认指定路径下存在 tape 文件
- 读取 tape 文件内容
- 验证必需的指令:
Output指令指定 GIF 的目标路径- 至少包含一个操作命令(Type、Enter 等)
阶段 2:检查 VHS 安装情况
which vhs && vhs --version
如果未安装:
# Linux/WSL
go install github.com/charmbracelet/vhs@latest
# macOS
brew install charmbracelet/tap/vhs
# Also requires ttyd and ffmpeg
阶段 3:执行录制
vhs <tape-file.tape>
VHS 将会:
- 解析 tape 文件指令
- 启动虚拟终端(ttyd)
- 按照时间安排执行命令
- 捕获帧
- 使用 ffmpeg 编码为 GIF
阶段 4:验证输出
- 检查
Output路径下是否存在 GIF 文件 - 确认文件大小不为零
- 报告成功并提供输出位置
退出条件
- 在指定的
Output路径下创建 GIF 文件 - 文件大小表明录制成功(通常 >50KB)
- VHS 执行未显示错误消息
故障排除
常见问题
如果找不到 vhs,请确认 Go bin 目录已加入 PATH(通常为 ~/go/bin)。如果录制无法启动,请确保已安装 ttyd 和 ffmpeg,因为 VHS 依赖它们进行终端模拟和视频编码。如果写入 GIF 时出现“permission denied”错误,请检查输出目录是否存在且可写。
评论
支持 Markdown