Skip to content

Commit c71b63b

Browse files
author
root
committed
docs: explain compare API use case for local automation
1 parent 178b8ca commit c71b63b

2 files changed

Lines changed: 3 additions & 0 deletions

File tree

docs/browser-use-debugging.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -423,6 +423,7 @@ <h2 id="compare-run-metadata-checklist">Compare failed and successful Browser Us
423423
browsertrace compare &lt;failed_run_id&gt; &lt;success_run_id&gt; --json</code></pre>
424424
<p>While the local BrowserTrace UI is running, local wrappers and tools can request the same first-divergence payload through the web API:</p>
425425
<pre><code>curl http://127.0.0.1:3000/api/compare/&lt;failed_run_id&gt;/&lt;success_run_id&gt;</code></pre>
426+
<p>The API endpoint is useful for local dashboards, scripts, or automation preflight checks that need the same first-divergence JSON payload.</p>
426427
<p>Example compare output:</p>
427428
<pre><code>$ browsertrace compare failed-local-html-upload good-local-html-upload
428429
First divergent step: 3

tests/test_metadata.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4004,6 +4004,8 @@ def test_browser_use_guide_documents_compare_run_metadata_checklist():
40044004
)
40054005
assert "local BrowserTrace UI is running" in section
40064006
assert "same first-divergence payload" in section
4007+
assert "local dashboards, scripts, or automation preflight checks" in section
4008+
assert "same first-divergence JSON payload" in section
40074009
assert "first divergent step" in section
40084010
assert "Example compare output:" in section
40094011
assert "$ browsertrace compare failed-local-html-upload good-local-html-upload" in section

0 commit comments

Comments
 (0)