Usage

mix bench [options] [<path>...]

When one or more arguments are supplied, each of them will be treated as a wildcard pattern and only those bench tests that match the pattern will be selected.

By default, all files matching bench/**/*_bench.exs are executed. Each test will run for as many iterations as necessary so that the total running time is at least the specified duration.

In the end, the number of iterations and the average time of a single iteration are printed to the standard output. Additionally, the output in machine format is written to a snapshot file in bench/snapshots/.

Options

-f, --format
    Print it in the specific format.

    One of: raw, plain (default) and markdown.

-q, --quiet
    Don't print progress report while the tests are running.

    Reports are printed to stderr so as not to interfere with output
    redirection.

-d <duration>, --duration=<duration>
    Minimum duration of each test in seconds. Default: 1.

-o <path>, --output=<path>
    Path to the directory in which to store snapshots. The directory will
    be created if necessary.

    Setting it to an empty value will prevent benchfella from creating
    any files or directories.

    Default: bench/snapshots.

--no-compile
    Do not compile the target project before running benchmarks.

    NOTE: as of Elixir 1.0.4, this option only works when using the archive.
    If you include Benchfella as a dependency, your project will always be
    recompiled prior to running any 'bench.*' task.