Zonemaster-CLI
Purpose
This Git repository is one of the components of the Zonemaster software and contains the source for the Zonemaster-CLI utility.
For an overview of the Zonemaster software, please see the Zonemaster repository.
Prerequisite
Before you install the Zonemaster-CLI utility, you need the Zonemaster-Engine test framework installed. Please see the Zonemaster Engine installation instructions.
Installation
For installation, see the installation document.
Configuration
This repository does not need any specific configuration.
Docker
Zonemaster-CLI is available on Docker Hub, and can be conveniently downloaded and run without any installation. See USING Zonemaster-CLI for how to run Zonemaster-CLI on Docker.
To build your own Docker image, see the Docker Image Creation documentation.
Documentation
Run zonemaster-cli --help to get brief descriptions of a selection of the most
important command line options.
For complete reference documentation, see the manual page by running man zonemaster-cli.
Additional end-user documentation is available in the USING document.
When developing Zonemaster-CLI, refer to the development documentation.
CI artifact
A tarball (Zonemaster-CLI-<version>.tar.gz) is built and uploaded as a GitHub Actions artifact on every push and pull request. This artifact can be useful for release testing and PR review.
To download it:
- Go to the Actions tab of the repository.
- Select a workflow run (e.g. for a specific PR or branch).
- Scroll to the bottom of the run summary to the Artifacts section.
- Download the artifact named
Zonemaster-CLI-<version>-<short_sha>. The artifact name includes the module version and the first 7 characters of the commit SHA.
Participation, Contact and Bug reporting
For participation, contact and bug reporting, please see the main Zonemaster README.
License
This is free software under a 2-clause BSD license. The full text of the license can be found in the LICENSE file included in this respository.