Specsheet

Command-line options

Here is how you run it.

Running modes

-c, --syntax-check

Don’t run, just check the syntax of the input files

-C, --list-commands

Don’t run, just list the commands that would be executed

-l, --list-checks

Don’t run, just list the checks that would be run

--list-tags

Don’t run, just list the tags defined in the input documents

--random-order

Run the checks in a random order

--continual

Run the checks indefinitely

--delay=DURATION

Amount of time to delay between checks

-j, --threads=NUM

Number of threads to run in parallel

-O, --option KEY=VAL

Set a global option, or override something in the environment

-z, --analysis

Run analysis after running checks if there are errors

Side process options

-x, --exec

Process to run in the background during execution

--exec-delay=DURATION

Wait an amount of time before running checks

--exec-port=PORT

Wait until a port becomes open before running checks

--exec-file=PATH

Wait until a file exists before running checks

--exec-line=REGEX

Wait until the process outputs a line before running checks

--exec-kill-signal=SIGNAL

Signal to send to the background process after finishing

Filtering options

-t, --tags=TAGS

Comma-separated list of tags to run

--skip-tags=TAGS

Comma-separated list of tags to skip

-T, --types=TYPES

Comma-separated list of check types to run

--skip-types=TYPES

Comma-separated list of check types to skip

Console output options

-s, --successes=SHOW

How to show successful results (hide, show, expand)

-f, --failures=SHOW

How to show failed results (hide, show, expand)

--summaries=SHOW

Whether to show the summary lines

-P, --print=FORMAT

Change the output format (ansi, dots, json-lines, tap)

--colour, --colour=WHEN

When to colourise the output (always, automatic, never)

Results document options

--html-doc=PATH

Produce an output HTML document

--json-doc=PATH

Produce an output JSON document

--toml-doc=PATH

Produce an output TOML document