Support

Documentation

The validate command
Prev Available commands Next

The validate command

Syntax:

/path/to/php unite.phar validate fileName [--log=logPath] [--tmp=tempPath]
  [--json=jsonPath] [--yaml=yamlPath]
  [--certificate=certificatePath] [--verbose] [--quiet] [--nocolor]

Validates the contents of a configuration file and the command line options. It does NOT run the site restoration.

It can also convert from XML, JSON, JSON5 and YAML to JSON and YAML.

Think of it as a combined linter and file conversion tool.

fileName

Mandatory. The path to a UNiTE XML, JSON, JSON5 or YAML file which tells it what to do.

The path can be either absolute, or relative to the current working directory.

The path can be either absolute, or relative to the current working directory.

Use the special value STDIN to tell UNiTE to take its configuration file from the standard input instead of a file. This means that you can pipe a configuration output by another programme into UNiTE, e.g. cat /some/file.xml | /path/to/php unite.phar validate STDIN

--json=/path/to/file.json

Exports the validated configuration data as a JSON/JSON5 document which is saved in the file /path/to/file.json.

This is useful for converting an XML or YAML configuration file to JSON/JSON5.

--yaml=/path/to/file.yaml

Exports the validated configuration data as a YAML document which is saved in the file /path/to/file.yaml.

This is useful for converting an XML, JSON or JSON5 configuration file to YAML.

--verbose

Enables verbose mode. This turns on verbose output.

--quiet

Print a minimal amount of information. Will be overridden by the --verbose option if both are specified.

--nocolor

Disable color output. Useful if you are running UNiTE through a CRON job and are receiving its output by email.

--log=/path/to/log/directory

Set the directory where the UNiTE execution log file will be stored. If this option is not provided, UNiTE defaults to the current working directory.

--tmp=/path/to/temp/directory

Set the directory where UNiTE will store temporary files. If this option is not provided, UNiTE defaults to the Operating System's temporary directory.

--certificate=/path/to/certificate.pem

Add /path/to/certificate.pem to the list of valid certification authorities. Use this option when you are going to be backing up a site which is using a self-signed SSL certificate, or a certificate signed by a certification authority that's not public or otherwise not in the list of trusted certification authorities. The file must be PEM-encoded.

Prev Up Next
The restore command Home Chapter 3. Restoring sites with UNiTE