Communitygithub.com

ProofShot — 視覺驗證工作流程

在真實瀏覽器中對 UI 元件或頁面進行視覺驗證,自動記錄影片、截圖及錯誤報告,並可將驗證結果發佈到 PR 上。

ProofShot — 視覺驗證工作流程 是什麼?

ProofShot 是一個開源、與代理無關的 CLI 工具,讓開發者或 AI 代理能夠在自己的工作中即時進行視覺驗證。當你新增或修改 UI 元件、修復視覺錯誤後,可透過 three-step 工作流程啟動瀏覽器、操作並截圖,最後自動停止錄製並產生包含影片、截圖及錯誤報告的 SUMMARY.md。支援 GitHub PR 自動上傳與評論,驗證結果可直接附到對應的 Pull Request 上。該工具支援 macOS、Linux 及 Windows 作業系統,並可與任何 AI 代理平台(如 Claude Code、Cursor、Codex)整合。使用 ProofShot 可確保人類在審查時擁有完整的視覺證據,大幅提升協作品質與效率。

相容平台~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/AmElmo/proofshot/tree/HEAD/skills/claude

在你喜歡的 AI 中提問

開啟一個已預先載入此 Agent Skill 的新對話。

說明文件

ProofShot — 視覺驗證工作流程 是做什麼的?

ProofShot 是一個開源、與代理無關的 CLI 工具,讓你在真實瀏覽器中驗證自己的工作 — 包含影片證明、螢幕截圖和錯誤報告,無供應商鎖定。

何時使用

請在以下情況後使用 ProofShot:

  • 建立新的 UI 功能或頁面
  • 修改現有的 UI 元件
  • 修復視覺錯誤
  • 任何會影響使用者所見內容的變更

工作流程(請務必遵循以下 3 個步驟)

步驟 1:啟動工作階段

proofshot start --run "your-dev-command" --port PORT --description "what you are about to verify"

這會開啟瀏覽器並開始錄製。如果連接埠已被佔用,proofshot 會自動終止現有程序。

一律使用 --run 讓 proofshot 啟動並擷取你的開發伺服器輸出(伺服器記錄會出現在驗證報告中)。 只有當伺服器是由使用者或其他程序明確啟動時,才可省略 --run — 否則無法擷取伺服器記錄。

如果前一個工作階段未正常停止,請加上 --force 以覆蓋。

步驟 2:操作瀏覽器並進行測試

使用 proofshot exec 來導覽、互動和驗證:

proofshot exec snapshot -i                                    # 查看可互動元素
proofshot exec open http://localhost:PORT/page                # 導覽到某個頁面
proofshot exec click @e3                                      # 點擊按鈕
proofshot exec fill @e2 "[email protected]"                    # 填寫表單欄位
proofshot exec screenshot step-NAME.png                       # 擷取關鍵時刻

在重要時刻擷取螢幕截圖 — 這些將成為視覺證明。 透過讀取快照輸出,驗證你預期看到的內容。

步驟 3:停止並打包驗證結果

proofshot stop

這會停止錄製,收集主控台及伺服器錯誤,並產生包含影片、螢幕截圖和錯誤報告的 SUMMARY.md。

步驟 4(可選):將驗證結果發佈到 PR

proofshot pr              # 自動從目前分支偵測 PR
proofshot pr 42           # 指定特定的 PR 編號

這會將螢幕截圖和影片上傳到 GitHub,並在 PR 上張貼格式化評論。預設使用官方的 GitHub Contents API 在 proofshot-artifacts 分支上儲存。若需使用 GitHub 附件網址,請加上 --upload-provider github-web-attachments。

小技巧

  • 務必提供有意義的 --description,讓人類知道測試了什麼內容
  • 在關鍵動作前後都進行截圖(例如:表單提交前、重新導向後)
  • 如果在驗證過程中發現錯誤,請修正後重新執行工作流程
  • 在停止後使用 proofshot pr 將驗證結果直接附加到 Pull Request 上

Individual skills in this repo

This repo contains 3 individual skills — each has its own dedicated page.

相關技能