工程開發
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 查看