CLI Reference

Primary commands

The CLI is the main entry point for local and CI runs. Use it to initialize projects, run tests, open the local UI, launch the recorder, list Android devices, clean old reports, and check the environment.

Run flags

Most teams use `orbittest run` with a small set of flags: workers, retries, CI mode, sharding, trace capture, Smart Report, and GitHub annotations. Keep command lines readable in package scripts.

Local scripts

Add npm scripts for the common paths so contributors do not need to memorize flags. A good project usually has scripts for smoke, full, CI, and report review.

Reference table

Practical checklist

• Keep the workflow readable enough that a QA engineer, developer, or product teammate can understand the intent without opening application source code.
• Prefer user-visible names, stable configuration, and clear evidence over hidden assumptions or brittle implementation details.
• Run the smallest useful check locally before adding it to CI, then verify that failures produce screenshots, logs, traces, or reports that explain what happened.
• Review this part of the suite regularly so outdated examples, stale setup, and obsolete workarounds do not reduce trust in the automation.

Common mistakes to avoid

• Do not add automation only to increase test count. Each page and test should protect a clear user journey, release risk, or debugging need.
• Do not hide important behavior inside helpers so deeply that the test no longer explains what the user is doing.
• Do not rely on fixed sleeps when the application can expose a meaningful ready state such as visible text, URL change, element availability, or completed evidence capture.
• Do not ignore failing artifacts. A report, screenshot, trace, or log entry should feed back into better product code, better waits, or clearer test data setup.