ProofShot — ビジュアル検証ワークフロー は何をしますか?
ProofShotは、オープンソースでエージェント非依存のCLIです。実際のブラウザ上で自身の作業を検証し、動画・スクリーンショット・エラー報告を生成します。ベンダーロックインはありません。
使用すべき場面
ProofShotは以下の後に使用します:
- 新しいUI機能やページを構築した後
- 既存のUIコンポーネントを変更した後
- ビジュアルバグを修正した後
- ユーザーが見る画面に影響を与える変更があった場合
ワークフロー(以下の3ステップを常に実行してください)
ステップ 1: セッションを開始
proofshot start --run "your-dev-command" --port PORT --description "これから検証する内容"
これによりブラウザが開き、録画が開始されます。ポートが既に使用中の場合は、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の添付ファイルURLを明示的に使用したい場合は --upload-provider github-web-attachments を指定します。
ヒント
- 常に意味のある
--descriptionを含めて、人間が何をテストしたかわかるようにしましょう - 重要なアクションの前後で必ずスクリーンショットを撮影してください(例:フォーム送信前、リダイレクト後)
- 検証中にエラーが見つかった場合は、修正してワークフローを再実行してください
- 停止後は
proofshot prを使用して、直接プルリクエストに証明を添付しましょう