Skip to content

docs: explain when the local compare API is better than CLI output#385

Merged
aaronlab merged 1 commit into
aaronlab:mainfrom
ykd007:docs/compare-api-use-case
May 14, 2026
Merged

docs: explain when the local compare API is better than CLI output#385
aaronlab merged 1 commit into
aaronlab:mainfrom
ykd007:docs/compare-api-use-case

Conversation

@ykd007
Copy link
Copy Markdown
Contributor

@ykd007 ykd007 commented May 13, 2026

Closes #384

Added a sentence in the Compare failed and successful Browser Use runs section explaining when to prefer the local API endpoint over browsertrace compare:

Prefer the local API endpoint over the CLI output when a script, dashboard, or automation preflight check needs the first-divergence payload as JSON — for example, a CI step that reports the exact divergent action back to a tracking system, or a local debugging UI that visualises the diff without shelling out.

Also updated test_browser_use_guide_documents_compare_run_metadata_checklist in tests/test_metadata.py to assert the new sentence is present.

Verified:

uv run --python 3.11 --extra dev pytest tests/test_metadata.py::test_browser_use_guide_documents_compare_run_metadata_checklist -q
1 passed

The guide already showed the curl example for the local API endpoint
but didn't say when to prefer it over the CLI. Added a sentence in the
Compare section explaining the API is the right choice when a script,
dashboard, or automation preflight check needs the first-divergence
payload as JSON rather than terminal-formatted text.

Updated test_browser_use_guide_documents_compare_run_metadata_checklist
to assert the new sentence is present.

Closes aaronlab#384
Copy link
Copy Markdown
Owner

@aaronlab aaronlab left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. You claimed #384 first, and this covers the requested Browser Use guide sentence plus metadata coverage.\n\nLocal verification after merging current into the PR branch:\n- ........................................................................ [ 17%]
........................................................................ [ 35%]
........................................................................ [ 53%]
........................................................................ [ 71%]
........................................................................ [ 89%]
......................................... [100%]
401 passed in 0.30s -> 401 passed\n- -> passed

Copy link
Copy Markdown
Owner

@aaronlab aaronlab left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. You claimed #384 first, and this covers the requested Browser Use guide sentence plus metadata coverage.

Local verification after merging current origin/main into the PR branch:

  • uv run --python 3.11 --extra dev pytest tests/test_metadata.py -q -> 401 passed
  • git diff --check origin/main...HEAD -> passed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: explain compare API use case in Browser Use guide

2 participants