Skip to content

zonemaster/zonemaster-cli

Repository files navigation

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

Other than the installation documentation, no specific documentation is needed. The USING document provides an overview on how to use the CLI.

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.