vhs-recorder

📼 专业终端演示录制与动画生成器

🥥63总安装量 17评分人数 10
100% 的用户推荐

基于 Charm 官方 VHS 工具的纯文档型技能,提供声明式语法指导,帮助开发者零代码创建高质量 CLI 演示 GIF/视频,提升技术文档专业度与传播效果。

A

基本安全,请在特定环境下使用

  • 来自社区或个人来源,建议先隔离验证
  • ✅ 纯文档型资产,无代码执行风险,所有操作需用户手动在本地环境执行
  • ✅ 无危险函数调用(eval/exec/system/subprocess),无网络通信与数据收集行为
  • ⚠️ 代码块包含 VHS tape 语法示例,需在本地安装 vhs 工具后方可执行,注意验证 tape 文件内容
  • ⚠️ 示例中包含 `rm -rf` 等敏感命令演示,建议在隔离环境中进行敏感操作录制
  • ⚠️ 来源为 T3 级个人开发者账号,非官方组织维护,建议关注上游 VHS 官方更新

使用说明

VHS Recorder 是一款基于 Charm 生态的 VHS 终端录制工具的纯文档型技能,旨在帮助开发者通过声明式 DSL 语法创建专业级命令行演示内容。

核心用法

该技能通过结构化的 Tape 文件指导用户完成终端录制全流程。用户需编写 .tape 配置文件,按顺序定义输出格式(Output)、终端设置(Set)、环境要求(Require)、隐藏操作(Hide/Show)及核心录制指令(Type、Enter、Wait、Sleep 等)。技能提供了完整的命令参考表,涵盖键盘输入、导航控制、剪贴板操作、环境变量设置及截图功能,支持 GIF、MP4、WebM、ASCII 等多种输出格式,满足不同场景的文档展示需求。

显著优点

首先,声明式 DSL 设计使得录制脚本具有极高的可读性和可维护性,无需编写复杂代码即可精确控制 50ms 级别的打字速度和动画节奏。其次,内置的 "3-2-1 时间规则" 和 Hide/Show 机制帮助用户轻松制作专业级演示,自动处理终端清理和过渡动画。第三,丰富的主题系统(如 Catppuccin Mocha)和字体定制能力确保输出视觉效果符合现代审美标准。此外,ASCII 预览模式支持即时测试无需等待 ffmpeg 渲染,大幅提升迭代效率。

潜在缺点与局限性

该技能本质上为使用指南,不自动执行任何录制操作,所有功能依赖用户在本地预先安装 VHS 工具链(vhs、ttyd、ffmpeg),对 Windows 用户或非技术背景人员存在环境配置门槛。作为 T3 级个人开发者维护的社区项目,其更新频率和长期维护稳定性不及官方技能。此外,Tape 语法虽简单但功能边界有限,复杂交互场景(如需要人工判断的动态提示)难以自动化处理。

适合的目标群体

主要面向开源项目维护者(制作 README 动画)、CLI 工具开发者(产品演示)、技术文档工程师(教程视频)、DevOps 及 SRE 团队(操作手册可视化)和教育内容创作者(编程教学素材)。特别适合需要频繁展示命令行操作但缺乏视频编辑技能的技术人员。

使用风险与注意事项

执行安全:虽然 skill 本身无代码执行风险,但生成的 tape 文件在本地执行时可能包含 rm -rf 等危险命令演示,建议在 Docker 容器或临时目录中运行录制环境。依赖风险:ffmpeg 和 ttyd 的版本兼容性可能导致录制失败,需确保工具链完整安装。隐私风险:录制过程中可能意外暴露本地环境变量、文件路径或敏感配置,建议通过 Env 命令设置虚拟值并使用 Hide 段落隔离敏感操作。性能风险:高分辨率(1200x600)和长时长录制可能消耗大量 CPU 资源,建议合理设置 Sleep 时间避免过度渲染。

vhs-recorder 内容

文件夹图标references文件夹
手动下载zip · 5.8 kB
examples.mdtext/markdown
请选择文件