Command line reference

Every switch the command line takes, in the groups and the order certdoctor --help prints them.

Usage

certdoctor <url> [options]
certdoctor --from <file> [options]

The URL needs an explicit http:// or https:// scheme. Without one there is no way to tell a host name from a port number. --from takes the place of the URL: it runs nothing, writes a saved report in the format asked for, and ends with 0 once it is written.

What to examine

--pac-url <url>

also read this proxy auto-configuration script and say where it sends the target

--from <file>

instead of a URL: write a report saved earlier with --json again, in the format asked for, without running anything. A single dash reads it from standard input

Output

--format <terminal|json|md|html>

how to write the report. Defaults to terminal

--json

the same as --format json

--out <path>

where to write the report. A single dash means standard output, which is the default

--redact

mask host names, paths and user names. Credentials are masked with or without it

Channels

--quiet

keep the log on standard error down to failures

--verbose

say more on standard error about what is happening

--no-color

never colour the output. NO_COLOR in the environment does the same

Budget

--timeout <seconds>

limit for the whole run in seconds, at least 0.001. Zero means no limit. Defaults to 60

--probe-timeout <seconds>

limit for one layer in seconds, at least 0.001. Zero means no limit. Defaults to 10

Meta

--version

print the version of the tool and of every schema it emits

--license

print the licence, then the notices of the third party code in this binary

--help, -h

print this text

Environment

NO_COLOR, set to any non-empty value, turns colour off. It is the only variable that changes what certdoctor does, and it changes only how the report looks. Proxy and trust store variables are read as things to diagnose, never as configuration for certdoctor.

Exit codes

Every ending has its own code. Exit codes lists them.