工程开发
pr-demo avatar

pr-demo

为 Pull Request 与文档制作精美的终端动画演示,支持使用 asciinema、agg 与 svg-term-cli 进行录制与转换。

简介

此技能提供了一个结构化的工作流程,用于生成高质量的终端动画录制,非常适合在 GitHub 的 Pull Request 或技术文档中演示软件功能。它简化了从脚本编写、环境设置到录制、转换与验证的整个过程。通过使用 asciinema 进行录制,以及使用 agg 或 svg-term-cli 输出 GIF 与 SVG,确保您的演示既轻量又专业,并对审查人员而言清晰易读。

  • 自动化工作流程:脚本 → 录制 → 转换 → 嵌入。

  • 优化的输出格式:生成小巧的 GIF (< 5MB) 以利 GitHub 原生嵌入,或是生成 SVG (< 500KB) 以满足较小的存储需求。

  • 自我验证机制:包含自动化检查步骤(文件大小、持续时间、元数据),并使用 LLM 作为评审进行视觉验证,确保可读性与安全性。

  • 环境标准化:通过移除敏感数据、强制使用特定终端尺寸 (100x24) 以及标准化配色,确保终端呈现干净。

  • 实用指导:提供让演示保持精简(20-30 秒)、强调“顿悟时刻 (aha moment)”以及清理终端提示符的最佳实践模式。

  • 在录制前务必撰写演示脚本,以维持焦点并确保“顿悟时刻”能被清楚展现。

  • 使用指定的 100x24 尺寸进行 asciinema rec,以确保录影在不同设备与屏幕尺寸上保持可读性。

  • 使用提供的提示词验证输出文件,确保没有泄露 API 密钥或本地文件路径等敏感信息。

  • 优先选择 asciinema + agg 工具链以获得最佳兼容性;若文件大小受限,则切换至 svg-term-cli

  • 将所有产生的素材(包括原始 .cast 文件与最终的 .gif 或 .svg 演示)存放在 docs/demos/ 目录中,以便进行有条理的文档管理。

仓库统计

Star 数
2,784
Fork 数
260
Open Issue 数
29
主要语言
Rust
默认分支
main
同步状态
空闲
最近同步时间
2026年5月1日 07:15
在 GitHub 查看