hledger/hledger/Hledger/Cli/Commands/Test.md
Simon Michael 4a7a700d93 ;doc: fix flags marker appearing in manuals
$FLAGS$ didn't work (nor =FLAGS=); _FLAGS it is..

[ci skip]
2020-01-05 07:41:01 -08:00

753 B
Raw Blame History

test
Run built-in unit tests.

_FLAGS

This command runs the unit tests built in to hledger and hledger-lib, printing the results on stdout. If any test fails, the exit code will be non-zero.

This is mainly used by hledger developers, but you can also use it to sanity-check the installed hledger executable on your platform. All tests are expected to pass - if you ever see a failure, please report as a bug!

This command also accepts tasty test runner options, written after a (double hyphen). Eg to run only the tests in Hledger.Data.Amount, with ANSI colour codes disabled:

$ hledger test -- -pData.Amount --color=never

For help on these, see https://github.com/feuerbach/tasty#options (-- --help currently doesnt show them).