NAME
zonemaster-cli - run Zonemaster tests from the command line
SYNOPSIS
zonemaster-cli [--help | --version | --list-tests]
zonemaster-cli [OPTIONS] --dump-profile
zonemaster-cli [OPTIONS] DOMAINNAMEDESCRIPTION
zonemaster-cli is a command-line interface to the Zonemaster test engine. It takes instructions the user provides as command line arguments, transforms them into suitable API calls to the engine, runs the test suite and prints the resulting messages. By default, the messages will be translated by the engine's translation module, with the corresponding timestamp and logging level when printed. See the available options below.
OPTIONS
Special Options
- -h, --help
-
Print brief usage information and exit. (run `man zonemaster-cli` for the full manual page)
- --version
-
Print version information and exit.
- --list-tests
-
Print all test cases listed in the test modules, then exit.
- --dump-profile
-
Print the effective profile used in JSON format, then exit.
Testing Options
- --test=TESTCASE, --test=TESTMODULE
-
Limit the testing suite to run only the specified tests. Can be specified multiple times. (default: all test cases)
- --level=LEVEL
-
Specify the minimum level of a message to be printed. (default: NOTICE)
- --[no-]progress
-
Print an activity indicator ("spinner"). (default: enabled if the process' standard output is a TTY)
- --[no-]ipv4, --[no-]ipv6
-
Enable or disable queries over IPv4 or IPv6. (default: both enabled)
- --profile=FILE
-
Override the Zonemaster Engine default profile data with values from the given profile JSON file.
Formatting Options
- --[no-]json
-
Print results as JSON instead of human language. (default: disabled)
- --locale=LOCALE
-
Specify which locale to be used by the translation system. (default: system locale or English)
EXAMPLES
zonemaster-cli zonemaster.net
zonemaster-cli --test=delegation --level=info --no-time zonemaster.net
zonemaster-cli --test=delegation01 --level=debug zonemaster.net
zonemaster-cli --list-testsPROFILES
The testing and result analysis performed by Zonemaster Engine is always guided by a profile. Zonemaster Engine has a default profile with sensible defaults. Zonemaster CLI allows users to override the default profile data with values from a profile JSON file with the --profile option. For details on profiles and how they are represented in files, see Zonemaster::Engine::Profile.
CONFIGURATION
If there is a readable file /etc/zonemaster/cli.args (Linux style), each line in that file will be prepended as an argument on the command line. If no /etc/zonemaster/cli.args is found (or is not readable) but /usr/local/etc/zonemaster/cli.args (FreeBSD style) is found and readable then that file will be used instead. Only one global file is loaded.
If there is a readable file .zonemaster/cli.args in the user's home directory, it will be used in the same way even when a global file has been loaded. Any argument in user's cli.args will override the same argument in the global config file.
For example, if one would like to by default run with the log level set to DEBUG and with translation to human-readable messages turned off, one could put this in the config file:
--raw
--level=DEBUGOnly one argument per line. If the argument has a value there must be a "=" between argument and value. A line starting with "#" is a comment. Comments cannot be added on lines with arguments.
Any arguments actually given on the command line will override what is in any of the loaded config files.
SEE ALSO
More complete documentation on Zonemaster and its tests can be found on https://doc.zonemaster.net.
AUTHOR
Calle Dybedahl <calle@init.se> and others from the Zonemaster project