agent-browser

代理ブラウザーを使用したブラウザー自動化

コアワークフロー

ブラウザー自動化はすべて、次のパターンに従います。

1. 移動: agent-browser open <url>
2. スナップショット: agent-browser snapshot -i（@e1、@e2 などの要素参照を取得）
3. 操作: 参照を使ってクリック、入力、選択を行います
4. 再スナップショット: ページ移動や DOM の変更後に、新しい参照を取得します

agent-browser open https://example.com/form
agent-browser snapshot -i
# Output: @e1 [input type="email"], @e2 [input type="password"], @e3 [button] "Submit"

agent-browser fill @e1 "[email protected]"
agent-browser fill @e2 "password123"
agent-browser click @e3
agent-browser wait --load networkidle
agent-browser snapshot -i  # Check result

コマンドの連結

1 回のシェル呼び出しで、コマンドを && で連結できます。バックグラウンドデーモンを介してブラウザーの状態が維持されるため、コマンドの連結は安全で、個別に呼び出すより効率的です。

# Chain open + wait + snapshot in one call
agent-browser open https://example.com && agent-browser wait --load networkidle && agent-browser snapshot -i

# Chain multiple interactions
agent-browser fill @e1 "[email protected]" && agent-browser fill @e2 "password123" && agent-browser click @e3

# Navigate and capture
agent-browser open https://example.com && agent-browser wait --load networkidle && agent-browser screenshot page.png

連結する場合： 中間コマンドの出力を確認せずに次へ進める場合（例：open + wait + screenshot）は、&& を使用します。出力を先に解析する必要がある場合（例：スナップショットで参照を確認してから、その参照を使って操作する場合）は、コマンドを個別に実行します。

基本的なコマンド

# Navigation
agent-browser open <url>              # Navigate (aliases: goto, navigate)
agent-browser close                   # Close browser

# Snapshot
agent-browser snapshot -i             # Interactive elements with refs (recommended)
agent-browser snapshot -i -C          # Include cursor-interactive elements (divs with onclick, cursor:pointer)
agent-browser snapshot -s "#selector" # Scope to CSS selector

# Interaction (use @refs from snapshot)
agent-browser click @e1               # Click element
agent-browser click @e1 --new-tab     # Click and open in new tab
agent-browser fill @e2 "text"         # Clear and type text
agent-browser type @e2 "text"         # Type without clearing
agent-browser select @e1 "option"     # Select dropdown option
agent-browser check @e1               # Check checkbox
agent-browser press Enter             # Press key
agent-browser scroll down 500         # Scroll page

# Get information
agent-browser get text @e1            # Get element text
agent-browser get url                 # Get current URL
agent-browser get title               # Get page title

# Wait
agent-browser wait @e1                # Wait for element
agent-browser wait --load networkidle # Wait for network idle
agent-browser wait --url "**/page"    # Wait for URL pattern
agent-browser wait 2000               # Wait milliseconds

# Capture
agent-browser screenshot              # Screenshot to temp dir
agent-browser screenshot --full       # Full page screenshot
agent-browser screenshot --annotate   # Annotated screenshot with numbered element labels
agent-browser pdf output.pdf          # Save as PDF

# Diff (compare page states)
agent-browser diff snapshot                          # Compare current vs last snapshot
agent-browser diff snapshot --baseline before.txt    # Compare current vs saved file
agent-browser diff screenshot --baseline before.png  # Visual pixel diff
agent-browser diff url <url1> <url2>                 # Compare two pages
agent-browser diff url <url1> <url2> --wait-until networkidle  # Custom wait strategy
agent-browser diff url <url1> <url2> --selector "#main"  # Scope to element

よく使うパターン

フォームの送信

agent-browser open https://example.com/signup
agent-browser snapshot -i
agent-browser fill @e1 "Jane Doe"
agent-browser fill @e2 "[email protected]"
agent-browser select @e3 "California"
agent-browser check @e4
agent-browser click @e5
agent-browser wait --load networkidle

状態を保持した認証

# Login once and save state
agent-browser open https://app.example.com/login
agent-browser snapshot -i
agent-browser fill @e1 "$USERNAME"
agent-browser fill @e2 "$PASSWORD"
agent-browser click @e3
agent-browser wait --url "**/dashboard"
agent-browser state save auth.json

# Reuse in future sessions
agent-browser state load auth.json
agent-browser open https://app.example.com/dashboard

セッションの保持

# Auto-save/restore cookies and localStorage across browser restarts
agent-browser --session-name myapp open https://app.example.com/login
# ... login flow ...
agent-browser close  # State auto-saved to ~/.agent-browser/sessions/

# Next time, state is auto-loaded
agent-browser --session-name myapp open https://app.example.com/dashboard

# Encrypt state at rest
export AGENT_BROWSER_ENCRYPTION_KEY=$(openssl rand -hex 32)
agent-browser --session-name secure open https://app.example.com

# Manage saved states
agent-browser state list
agent-browser state show myapp-default.json
agent-browser state clear myapp
agent-browser state clean --older-than 7

データの抽出

agent-browser open https://example.com/products
agent-browser snapshot -i
agent-browser get text @e5           # Get specific element text
agent-browser get text body > page.txt  # Get all page text

# JSON output for parsing
agent-browser snapshot -i --json
agent-browser get text @e1 --json

並列セッション

agent-browser --session site1 open https://site-a.com
agent-browser --session site2 open https://site-b.com

agent-browser --session site1 snapshot -i
agent-browser --session site2 snapshot -i

agent-browser session list

起動中の Chrome への接続

# Auto-discover running Chrome with remote debugging enabled
agent-browser --auto-connect open https://example.com
agent-browser --auto-connect snapshot

# Or with explicit CDP port
agent-browser --cdp 9222 snapshot

ビジュアルブラウザー（デバッグ）

agent-browser --headed open https://example.com
agent-browser highlight @e1          # Highlight element
agent-browser record start demo.webm # Record session
agent-browser profiler start         # Start Chrome DevTools profiling
agent-browser profiler stop trace.json # Stop and save profile (path optional)

ローカルファイル（PDF、HTML）

# Open local files with file:// URLs
agent-browser --allow-file-access open file:///path/to/document.pdf
agent-browser --allow-file-access open file:///path/to/page.html
agent-browser screenshot output.png

iOS シミュレーター（モバイル Safari）

# List available iOS simulators
agent-browser device list

# Launch Safari on a specific device
agent-browser -p ios --device "iPhone 16 Pro" open https://example.com

# Same workflow as desktop - snapshot, interact, re-snapshot
agent-browser -p ios snapshot -i
agent-browser -p ios tap @e1          # Tap (alias for click)
agent-browser -p ios fill @e2 "text"
agent-browser -p ios swipe up         # Mobile-specific gesture

# Take screenshot
agent-browser -p ios screenshot mobile.png

# Close session (shuts down simulator)
agent-browser -p ios close

要件： Xcode を搭載した macOS、Appium（npm install -g appium && appium driver install xcuitest）

実機： 事前に設定済みであれば、物理的な iOS デバイスでも動作します。xcrun xctrace list devices で確認できる UDID を使って、--device "<UDID>" を指定してください。

差分の確認（変更の検証）

操作の実行後に diff snapshot を使うと、意図した効果が得られたか確認できます。このコマンドは、現在のアクセシビリティツリーと、セッションで最後に取得したスナップショットを比較します。

# Typical workflow: snapshot -> action -> diff
agent-browser snapshot -i          # Take baseline snapshot
agent-browser click @e2            # Perform action
agent-browser diff snapshot        # See what changed (auto-compares to last snapshot)

ビジュアルリグレッションテストや監視には、次を使用します。

# Save a baseline screenshot, then compare later
agent-browser screenshot baseline.png
# ... time passes or changes are made ...
agent-browser diff screenshot --baseline baseline.png

# Compare staging vs production
agent-browser diff url https://staging.example.com https://prod.example.com --screenshot

diff snapshot の出力では、追加を +、削除を - で示します。これは git diff と同様です。diff screenshot は、変更されたピクセルを赤色で強調した差分画像と、不一致の割合を生成します。

タイムアウトと読み込みの遅いページ

ローカルブラウザーでの Playwright のデフォルトのタイムアウトは 60 秒です。読み込みの遅いウェブサイトや大きなページでは、デフォルトのタイムアウトに頼らず、明示的に待機してください。

# Wait for network activity to settle (best for slow pages)
agent-browser wait --load networkidle

# Wait for a specific element to appear
agent-browser wait "#content"
agent-browser wait @e1

# Wait for a specific URL pattern (useful after redirects)
agent-browser wait --url "**/dashboard"

# Wait for a JavaScript condition
agent-browser wait --fn "document.readyState === 'complete'"

# Wait a fixed duration (milliseconds) as a last resort
agent-browser wait 5000

読み込みの遅いウェブサイトが続く場合は、open の後に wait --load networkidle を使って、スナップショットを取得する前にページが完全に読み込まれるようにします。特定の要素の表示に時間がかかる場合は、wait <selector> または wait @ref を使って、その要素が表示されるまで直接待機します。

セッション管理とクリーンアップ

複数のエージェントや自動化を並行して実行する場合は、競合を避けるため、必ず名前付きセッションを使用してください。

# Each agent gets its own isolated session
agent-browser --session agent1 open site-a.com
agent-browser --session agent2 open site-b.com

# Check active sessions
agent-browser session list

プロセスが残らないよう、作業が終わったら必ずブラウザーセッションを閉じてください。

agent-browser close                    # Close default session
agent-browser --session agent1 close   # Close specific session

前回のセッションが適切に閉じられていない場合、デーモンがまだ実行中の可能性があります。新しい作業を始める前に agent-browser close を使って終了してください。

参照のライフサイクル（重要）

ページが変更されると、参照（@e1、@e2 など）は無効になります。次の操作の後は、必ずスナップショットを再取得してください。

• ページ移動を伴うリンクやボタンのクリック
• フォームの送信
• 動的なコンテンツの読み込み（ドロップダウン、モーダル）

agent-browser click @e5              # Navigates to new page
agent-browser snapshot -i            # MUST re-snapshot
agent-browser click @e1              # Use new refs

注釈付きスクリーンショット（ビジョンモード）

--annotate を使うと、操作可能な要素に番号ラベルを重ねたスクリーンショットを撮影できます。各ラベル [N] は参照 @eN に対応します。また、参照がキャッシュされるため、別途スナップショットを取得しなくてもすぐに要素を操作できます。

agent-browser screenshot --annotate
# Output includes the image path and a legend:
#   [1] @e1 button "Submit"
#   [2] @e2 link "Home"
#   [3] @e3 textbox "Email"
agent-browser click @e2              # Click using ref from annotated screenshot

注釈付きスクリーンショットは、次のような場合に使用してください。

• ラベルのないアイコンボタンや、視覚的にのみ判別できる要素がページにある場合
• ビジュアルレイアウトやスタイルを確認する必要がある場合
• テキストのスナップショットでは見えない Canvas やグラフ要素がある場合
• 要素の位置を空間的に把握する必要がある場合

セマンティックロケーター（参照の代替）

参照を利用できない場合や信頼できない場合は、セマンティックロケーターを使用してください。

agent-browser find text "Sign In" click
agent-browser find label "Email" fill "[email protected]"
agent-browser find role button click --name "Submit"
agent-browser find placeholder "Search" type "query"
agent-browser find testid "submit-btn" click

JavaScript 評価（eval）

eval を使用して、ブラウザーコンテキストで JavaScript を実行します。シェルのクォート処理によって複雑な式が壊れることがあります。問題を避けるには、--stdin または -b を使用してください。

# Simple expressions work with regular quoting
agent-browser eval 'document.title'
agent-browser eval 'document.querySelectorAll("img").length'

# Complex JS: use --stdin with heredoc (RECOMMENDED)
agent-browser eval --stdin <<'EVALEOF'
JSON.stringify(
  Array.from(document.querySelectorAll("img"))
    .filter(i => !i.alt)
    .map(i => ({ src: i.src.split("/").pop(), width: i.width }))
)
EVALEOF

# Alternative: base64 encoding (avoids all shell escaping issues)
agent-browser eval -b "$(echo -n 'Array.from(document.querySelectorAll("a")).map(a => a.href)' | base64)"

重要な理由： シェルがコマンドを処理するとき、内側の二重引用符、! 文字（履歴展開）、バッククォート、$() によって、JavaScript が agent-browser に渡される前に壊れることがあります。--stdin および -b フラグを使用すると、シェルによる解釈を完全に回避できます。

使い分けの目安：

• 1 行で、入れ子の引用符がない場合 → 通常の eval 'expression' で問題ありません
• 入れ子の引用符、アロー関数、テンプレートリテラル、または複数行の場合 → eval --stdin <<'EVALEOF' を使用してください
• プログラムで生成したスクリプトの場合 → base64 形式で eval -b を使用してください

設定ファイル

永続的な設定を行うには、プロジェクトのルートに agent-browser.json を作成します。

{
  "headed": true,
  "proxy": "http://localhost:8080",
  "profile": "./browser-data"
}

優先順位（低い順）：~/.agent-browser/config.json < ./agent-browser.json < 環境変数 < CLI フラグ。カスタム設定ファイルを指定するには、--config <path> または AGENT_BROWSER_CONFIG 環境変数を使用します（ファイルが存在しない、または無効な場合はエラーで終了します）。すべての CLI オプションは camelCase のキーに対応します（例：--executable-path → "executablePath"）。ブール値フラグには true／false の値を指定できます（例：--headed false は設定を上書きします）。ユーザー設定とプロジェクト設定の拡張機能は、置き換えではなく統合されます。

詳細ドキュメント

リファレンス	使用する場面
references/commands.md	すべてのオプションを含むコマンドの完全なリファレンス
references/snapshot-refs.md	Ref のライフサイクル、無効化のルール、トラブルシューティング
references/session-management.md	並列セッション、状態の永続化、並行スクレイピング
references/authentication.md	ログインフロー、OAuth、2FA の処理、状態の再利用
references/video-recording.md	デバッグとドキュメント作成のための録画ワークフロー
references/profiling.md	パフォーマンス分析のための Chrome DevTools プロファイリング
references/proxy-support.md	プロキシ設定、地域別テスト、ローテーションプロキシ

すぐに使えるテンプレート

テンプレート	説明
templates/form-automation.sh	検証付きのフォーム入力
templates/authenticated-session.sh	一度ログインして、状態を再利用
templates/capture-workflow.sh	スクリーンショットを使ったコンテンツ抽出

./templates/form-automation.sh https://example.com/form
./templates/authenticated-session.sh https://app.example.com/login
./templates/capture-workflow.sh https://example.com ./output