Skip to main content

Getting Started

Before you start​

Runtime modes (capture, manual, auto, lab) require a Conalyz token. Static analysis works without one.

Don't have a token yet? Join the beta to get one instantly.

conalyz login cnlyz_...

Run Conalyz​

From your Flutter project directory:

conalyz

Conalyz starts your app and shows a mode menu:

  1.  Static       — analyse source code, no device needed
  2.  Capture      — navigate your app, record the flow → generates conalyz.yaml
  3.  Manual       — navigate yourself, name each screen at the prompt
  4.  Auto         — drive the app automatically using conalyz.yaml
  5.  Lab          — live mirror in your browser, experience it as disabled users do

  Select (1–5):

You can also skip the menu by passing the mode directly:

conalyz static     # analyse source code — no device needed
conalyz capture    # record a session → generates conalyz.yaml  (Android only)
conalyz manual     # navigate yourself, name each screen
conalyz auto       # drive the app using conalyz.yaml
conalyz lab        # live interactive window — see Lab Mode

Passing --dir without a mode defaults to static:

conalyz --dir .            # same as: conalyz static
conalyz --dir ./my-app     # analyse a project in another directory
tip

To target a specific device, pass Flutter flags after --:

conalyz auto -- --device-id emulator-5554

View the report​

After the session completes, Conalyz writes two files to the current directory:

  • conalyz_report.html — visual report with screenshots and highlighted violations
  • conalyz_report.json — structured data for CI integration or custom tooling

Open conalyz_report.html in any browser to review the findings.

Quick example output​

Launching lib/main.dart on sdk gphone16k arm64 in debug mode...
Running Gradle task 'assembleDebug'...                           1,055ms
✓ Built build/app/outputs/flutter-apk/app-debug.apk
Installing build/app/outputs/flutter-apk/app-debug.apk...          205ms
Syncing files to device sdk gphone16k arm64...                      15ms

─────────────────────────────────────────
  Conalyz — connected
  sdk_gphone16k_arm64  ·  480 dpi  ·  2.63× ratio
─────────────────────────────────────────

Screen name › Home
  Touch targets  ❌ 2 violation(s)
  Contrast       ✅ no violations
  Focus          ✅ no violations
  Labels         ❌ 1 violation(s)
  Saved — 3 violations found on "Home"

Screen name › done

─────────────────────────────────────────
  Reports saved → conalyz_report.html  |  conalyz_report.json
  1 screen  ·  3 total violations
─────────────────────────────────────────