alcotest-help.txt

NAME
       test.exe - Run all the tests.

SYNOPSIS
       test.exe [COMMAND] …

COMMANDS
       list [--color=WHEN] [OPTION]…
           List all available tests.

       test [OPTION]… [NAME_REGEX] [TESTCASES]
           Run a subset of the tests.

ARGUMENTS
       NAME_REGEX
           A regular expression matching the names of tests to run

       TESTCASES
           A comma-separated list of test case numbers (and ranges of
           numbers) to run, e.g: '4,6-10,19'. When specifying ranges, both
           '-' and '..' are accepted as valid separators.

OPTIONS
       --bail (absent ALCOTEST_BAIL env)
           Stop running tests after the first failure.

       -c, --compact (absent ALCOTEST_COMPACT env)
           Compact the output of the tests.

       --color=WHEN (absent ALCOTEST_COLOR env)
           Colorize the output. WHEN must be one of auto, always or never.
           Defaults to 'always' when running inside Dune, otherwise defaults
           to 'auto'.

       -e, --show-errors (absent ALCOTEST_SHOW_ERRORS env)
           Display the test errors.

       --json
           Display JSON for the results, to be used by a script.

       -o DIR
           Where to store the log files of the tests.

       -q, --quick-tests (absent ALCOTEST_QUICK_TESTS env)
           Run only the quick tests.

       --tail-errors=N (absent ALCOTEST_TAIL_ERRORS env)
           Show only the last N lines of output in case of an error.

       -v, --verbose (absent ALCOTEST_VERBOSE env)
           Display the test outputs. WARNING: when using this option the
           output logs will not be available for further inspection.

COMMON OPTIONS
       --help[=FMT] (default=auto)
           Show this help in format FMT. The value FMT must be one of auto,
           pager, groff or plain. With auto, the format is pager or plain
           whenever the TERM env var is dumb or undefined.

EXIT STATUS
       test.exe exits with:

       0   on success.

       123 on indiscriminate errors reported on standard error.

       124 on command line parsing errors.

       125 on unexpected internal errors (bugs).

ENVIRONMENT
       These environment variables affect the execution of test.exe:

       ALCOTEST_BAIL
           See option --bail.

       ALCOTEST_COLOR
           See option --color.

       ALCOTEST_COMPACT
           See option --compact.

       ALCOTEST_QUICK_TESTS
           See option --quick-tests.

       ALCOTEST_SHOW_ERRORS
           See option --show-errors.

       ALCOTEST_SOURCE_CODE_POSITION
           Whether Alcotest should guess the source code position of test
           failures, if any. Defaults to true, set to a falsy value to
           disable.

       ALCOTEST_TAIL_ERRORS
           See option --tail-errors.

       ALCOTEST_VERBOSE
           See option --verbose.

       CI  Whether Alcotest is running in a CI system, if set to 'true'.

       GITHUB_ACTIONS
           Whether Alcotest is running in GitHub Actions, if set to 'true'.
           Display tests errors and outputs GitHub Actions annotations.

       OCAMLCI
           Whether Alcotest is running in OCaml-CI, if set to 'true'. Display
           tests errors.