CLI Reference

Command Line Interface Reference

Walkman exposes a simple and intuitive CLI built with clap. It can run single test files or recursively execute a full directory of tests.

Basic Usage

Run a specific test:

walkman tests/basic_test.yml

Run a test suite (directory):

walkman tests/integrations/

When providing a directory, Walkman will scan for .yml and .yaml files, sort them alphabetically for deterministic execution, and provide a global summary at the end of the run.

Options

--nui (No UI)

Disables the dynamic Terminal User Interface (TUI). By default, Walkman uses crossterm to draw an animated interface that clears and redraws lines to look clean. While excellent for local development, this breaks Continuous Integration logs. The --nui flag forces Walkman to use a flat, append-only console reporter.

Usage:

walkman tests/ --nui

--verbose

Enables verbose logging for successful steps. By default, Walkman only prints raw outputs when a test fails. With --verbose, Walkman expands successful steps to display the exact output captured from the serial port, highlighting the matched expected string in green.

Usage:

walkman tests/ --verbose

Note: --verbose can be combined with --nui.