Quick start · Beta
User guide
Write once, test everywhere — shared AutomationId across platforms. Full reference: product docs. Also requirements & limits and the FAQ.
-
1
Install and open
Download Setup for Windows from the home page. If SmartScreen appears: More info → Run anyway (unsigned beta). Framework-dependent builds may need the .NET 10 Desktop Runtime — the home page install checklist says which kind you have.
-
2
Free beta starts automatically
On first launch, Setup builds unlock a 30-day free device trial — no key paste. Remaining time is under Settings → Beta license. When it ends, contact us for a renewal key (
LH1.) and activate it on the overlay. -
3
Choose the platform
Header Platform: Windows UIA (default) or Android (Appium). iOS is not available yet. Android needs
adb+ Appium 2 on the host — not bundled in the Lighthouse Setup (see docs → Android). -
4
Attach to a target
Windows: pick a process. Android: device + package → Connect (Appium must be reachable).
-
5
Create or select a test
Left column → New Test. Rename a test in the center column. Set group… / Edit tags… organize the list (one group, any number of tags); Dashboard can filter that set and Run filtered. The Tests column caption is the project name — use ⋯ → Rename project… if you want a short name for the CLI (
lighthouse run --project …. -
6
Inspect the UI map
Right Inspector: hover, click, review properties. Prefer a shared AutomationId — required for portable Windows ↔ Android steps (Flutter, .NET MAUI, etc.).
-
7
Record steps
Windows: Start Recording in the Inspector (F9), left-click the map (the app follows). Android: Start Recording in the Inspector (F9), click the map. Live input records a tap, a long-press, or a swipe (a drag is not a click). Typed text commits as one step when focus leaves the field. Optional: Research click (next to Properties) selects without driving the app.
-
8
Edit as script (optional)
Press Ctrl+E for the script editor (
tapOn,assertText,takeScreenshot, …). Ctrl+K opens the command palette (app actions and script verbs). Editing enter text, delay, wait, or assert name/text uses a form instead of chained prompts. Use ? Help (or Settings → Script commands…) for the full list, inserttapOnfrom the Inspector selection, and Ctrl+Enter to run. Define${USER}-style values under Tests ⋯ → Variables… (expanded at Run). On failure the editor opens on the failed line with the console under it. Details: docs → Script. -
9
Run the test
Run Test (F5), optional Console (Copy / resize), results on Dashboard. Switch Platform and re-run when the suite uses portable AutomationIds.
-
10
Save, export, Settings
Auto-save under LocalAppData. Prefer Settings for export format, find/wait timeout, script font, and Export suite JSON + screenshots… for CI. Setup installs: Settings → Check for updates. Help: commands, shortcuts, tutorial.
-
11
Optional: run from the CLI
For CI or a quiet console run, use the headless CLI against the same local store:
lighthouse projectsthenlighthouse run --project YourName. Filter with--group Smoke --tag login(repeat--tagfor OR; group and tags together are AND;--testwins). Portable path: export suite JSON +screenshots/, thenlighthouse run --app … --script suite.json.--artifacts-dircopies failure bundles beside the results. Override variables with--var KEY=value. Details: docs → CLI.
Credo — write once, test everywhere: set the same AutomationId in Flutter / MAUI on each OS, record once, then play the suite on Windows and Android.
Tip — elevated apps: if attach fails with an elevation message, run Lighthouse as Administrator or run the target without elevation.