Communitygithub.com

ProofShot — ビジュアル検証ワークフロー

UI機能のビジュアル検証を行います。UIコンポーネント、ページ、ビジュアル機能の構築・修正後にお使いください。動画録画とエラーキャプチャ付きの検証セッションを開始し、ブラウザを操作してテストし、停止して証跡を人間が確認できる形にまとめます。

ProofShot — ビジュアル検証ワークフロー とは?

ProofShot は、開発エージェントが行った UI 変更を、人間が視覚的にレビューできる形式で証拠として残すためのツールです。Step1 で `proofshot start` を実行すると、開発サーバーが起動し、ヘッドレスブラウザが開かれ、動画の録画が開始されます。Step2 では `proofshot exec` を使用して、ページ遷移、要素のクリック、フォーム入力などの操作を行い、`screenshot` コマンドで重要な瞬間を画像としてキャプチャします。Step3 の `proofshot stop` で録画を終了すると、コンソールエラーやサーバーエラーが収集され、動画、スクリーンショット、エラーレポートを含む `SUMMARY.md` が生成されます。オプションの Step4 では `proofshot pr` で、これらの証跡を GitHub のプルリクエストに自動投稿できます。このツールは、エージェントが行った変更を人間が効率的にレビューできるようにするため、CI/CD パイプラインやエージェント駆動開発のワークフローに非常に役立ちます。

対応~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/AmElmo/proofshot/tree/HEAD/test/fixtures/sample-app/.claude/skills/proofshot

お気に入りのAIに質問する

このエージェントスキルを事前に読み込んだ状態で新しいチャットを開きます。

ドキュメント

ProofShot — ビジュアル検証ワークフロー は何をしますか?

使用するタイミング

ProofShot を使用するのは、以下の後です。

  • 新しい UI 機能やページを構築した後
  • 既存の UI コンポーネントを修正した後
  • ビジュアルバグを修正した後
  • ユーザーの目に見える部分に影響を与える変更を行った後

ワークフロー(常にこの 3 つのステップに従ってください)

ステップ 1: セッションを開始する

proofshot start --description "これから検証する内容"

これにより開発サーバーが起動し、ヘッドレスブラウザが開き、録画が開始されます。 description に指定した説明は、人間が確認する証跡レポートに表示されます。

ステップ 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 の添付ファイル URL を特に使用したい場合は、--upload-provider github-web-attachments を使用してください。

ヒント

  • 人間が何をテストしたかわかるように、必ず意味のある --description を含めてください。
  • 重要なアクションの前 と 後の両方でスクリーンショットを撮影してください(例: フォーム送信前、リダイレクト後)。
  • 検証中にエラーを見つけた場合は、修正してからワークフローを再実行してください。
  • 停止した後、proofshot pr を使用して、証拠をプルリクエストに直接添付してください。

Individual skills in this repo

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

関連スキル