CLI Reference

Usage

conalyz [mode] [options] [-- flutter-run-args]

---

Modes

Mode	Description
static	Analyse source code directly — no device or token needed
capture	Record a live session → generates conalyz.yaml (Android only)
manual	Navigate the app yourself, name each screen at the prompt
auto	Drive the app automatically using a conalyz.yaml config file
lab	Open a live interactive window to experience the app as users with disabilities do
login	Store a Conalyz token — required before using runtime modes
logout	Remove the stored token

Omitting the mode shows an interactive menu. Passing --dir without a mode defaults to static.

lab runs in app mode inside a Flutter project (or with --dir), and in device mode elsewhere — letting you audit any app on a connected device. See Lab Mode.

---

Options

Flag	Short	Default	Description
--help	-h	—	Show help and exit
--platform	-t	mobile	Target platform for static mode: mobile or web. Ignored in runtime modes.
--config	-c	conalyz.yaml	Config file — output path for capture, input path for auto
--output	-o	. (current directory)	Directory to write reports into
--html / --no-html	—	on	Generate the HTML report
--json / --no-json	—	on	Generate the JSON report

Everything after -- is forwarded verbatim to flutter run:

conalyz auto -- --device-id emulator-5554 --dart-define=ENV=prod

---

Examples

# Activate a token (required for runtime modes)
conalyz login cnlyz_...

# Remove stored token
conalyz logout

# Show mode menu
conalyz

# Static analysis — no device needed (mobile platform by default)
conalyz static

# Static analysis with web-specific checks
conalyz static --platform web

# --dir without a mode defaults to static
conalyz --dir .
conalyz --dir ./my-app

# Capture mode — record a session, generates conalyz.yaml (Android)
conalyz capture

# Manual mode — navigate the app yourself
conalyz manual

# Lab mode — live interactive window (app mode in a Flutter project, device mode elsewhere)
conalyz lab

# Automated mode — driven by conalyz.yaml in the current directory
conalyz auto

# Automated mode with a custom config file
conalyz auto --config flows/staging.yaml

# Write reports to a specific directory
conalyz auto --output ./reports

# JSON report only — skip HTML
conalyz auto --no-html

# Target a specific device
conalyz auto -- --device-id emulator-5554

# Custom dart-define
conalyz auto -- --device-id emulator-5554 --dart-define=ENV=prod

---

Output files

By default, reports are written to the current directory:

conalyz_report.html
conalyz_report.json

With --output ./reports:

reports/conalyz_report.html
reports/conalyz_report.json

The output directory is created automatically if it does not exist.