Skip to content
Pages

Command line

Run Ezu through your app's bin/ezu, which adds --app and the tool's Gemfile. From the tool's own checkout, bundle exec exe/ezu … --app PATH does the same.

map

bin/ezu map [--locales en,ja]

Walks every flow in every slot and replaces tmp/ezu/. A failed run leaves the previous map and prints the failing step and a screenshot of it. Prints a summary: pages (mapped, fragments, unmapped, unreachable), states, screenshots, flows, and what changed.

check

bin/ezu check [--locales en,ja]

Runs map, then fails if a screenshot differs from its approval, a state is not approved, or an approved state is gone. See Approve and check.

approve

bin/ezu approve --all
bin/ezu approve --changed
bin/ezu approve STATE…

Approves states from the last map into ezu/approved.json. STATE is an id such as "groups#show/Balance graph", or a glob such as "groups#show/*".

Exit status

Status Meaning
0 Fine.
1 Screens differ from what is approved, or nothing is approved yet.
2 The run broke, or the command was wrong.

Environment

Variable Where What
EZU_PATH bin/ezu The tool's checkout, instead of ../ezu.
EZU_SLOTS, EZU_LOCALE, EZU_VIEWPORT the seed The slot being seeded.
EZU_SEED_OUT the seed Where to write the seed's JSON.
EZU_CLOCK_FILE, EZU_RANDOM_SEED the app The clock to read and the seed for randomness.