Command Line Reference

yp-data

Usage:

yp-data [options] input-file-name ... output-file-name
yp-data [options] -o output-file-name input-file-name ...

See Data Processor for detail.

file-names

Names of input or input+output files. Use - for STDIN/STDOUT.

--out-filename=FILENAME, -o FILENAME

Name of output file. Use - for STDOUT.

--include=DIR, -I DIR

Add search locations for item specified as relative paths. See also YP_INCLUDE_PATH.

--define=KEY=VALUE, -D KEY=VALUE

Map KEY to VALUE for variable substitutions.

--undefine=KEY, -U KEY

Unmap KEY for variable substitutions.

--no-environment, -i

Do not use environment variables in variable substitutions.

--unbound-placeholder=VALUE

Substitute an unbound variable with VALUE instead of failing. Use YP_ORIGINAL as VALUE to leave the original syntax unchanged on unbound variables.

--no-process-include

Do not process include file instructions.

--no-process-variable

Do not process variable substitutions.

--schema-prefix=PREFIX

Prefix for relative path schemas. See also YP_SCHEMA_PREFIX.

--time-format=NAME=FORMAT, --time-format=FORMAT

Format for date-time string substitutions. See also YP_TIME_FORMAT and YP_TIME_FORMAT_.

--time-ref=TIME

Reference value for date-time substitutions. See also YP_TIME_REF_VALUE.

yp-preprocesor

Usage:

yp-preprocesor input-file-name -o output-file-name [options]

See Data Pre-Processor for detail.

file-names

Names of input or input files. Use - for STDIN/STDOUT.

--out-filename=FILENAME, -o FILENAME

Name of output file. Use - for STDOUT.

--define=KEY=VALUE, -D KEY=VALUE

Map KEY to VALUE for variable substitutions. These override environment variables which are used by default in the variable substitution.

--no-environment, -i

Do not use environment variables in variable substitutions.

yp-schema

Usage:

yp-schema SCHEMA-FILE CONFIG-FILE

See Schema Processor for detail.

SCHEMA-FILE

Name of the JSON schema file to modularise.

CONFIG-FILE

Name of the configuration file.

Common Options

The following options apply to both yp-data, yp-preprocessor and yp-schema commands.

--help, -h

Show help message and exit.

--version, -V

Print version and exit.

Environment Variables

YP_INCLUDE_PATH

Set the search path for include files (that are specified as relative locations). Expect a list of folders/directories in the same syntax as a PATH like variable on the relevant platform. (E.g., a colon separated list on Linux/Unix and a semi-colon separated list on Windows.) See Modularisation / Include for more info.

YP_SCHEMA_PREFIX

Set a prefix for relative locations to JSON schema files. See Validation with JSON Schema for more info.

YP_TIME_FORMAT

Set the default time format. See String Value Date-Time Substitution for more info.

YP_TIME_FORMAT_<NAME>

Set a named time format. See String Value Date-Time Substitution for more info.

YP_TIME_REF_VALUE

Set the reference time. Expect an ISO-8601 compliant date-time string. See String Value Date-Time Substitution for more info.