NAME

qgoda schema - Print the Qgoda configuration schema

SYNOPSIS

qgoda [<global options>] schema [--format=FORMAT][--help]

Try 'qgoda --help' for a description of global options.

DESCRIPTION

Dump the JSON schema for the Qgoda configuration to the console (standard output).

Important! The Qgoda configuration schema is not constant. It depends on the directory from where you run the command, the set of plug-ins you have installed, and the locale you have configured. The purpose of the schema is not to be a standard of any kind but to validate your configuration file _config.yaml.

OPTIONS

-f, --format=FORMAT

Output the schema in format FORMAT. FORMAT can be one of json, yaml, "perl" or "storable".

If the output format "perl" is chosen, the schema is dumped with Data::Dumper. If the output format "storable" is chosen, the schema is dumped with Storable::nfreeze(). The latter is binary!

The default format is "json". If you plan to read and understand the output, consider using "yaml" instead.

Alternatively, pipe the output of "qgoda schema" through jq(1):

        qgoda schema | jq .

Or into a readable file:

        qgoda schema | jq . >filename.json

Do not omit the dot ("."), it is important!

-h, --help

Show this help page and exit.

BUGS AND CAVEATS

Since the schema is not constant, it should have a different $id attribute for every possible constellation.

SEE ALSO

qgoda(1), https://json-schema.org/, https://www.json.org/, http://yaml.org/, Data::Dumper, Storable, jq(1), perl(1)

QGODA

Part of Qgoda.