.TH "ALINEX" "" "October 2017" "" ""
.SH "NAME"
\fBAlinex\fR
.P
This module will help validating complex structures\. And should be used on all external information\.
Like configuration or user input\. It's strength are very complex structures and detailed checks\.
.SH Usage
.P
.RS 2
.nf
validator [options]\.\.\.
.fi
.RE
.P
You can run two different tasks\.
.P
\fBOnly check data structure:\fR
.P
.RS 2
.nf
validator \-\-input <file\-or\-dir> \-\-schema <file>
.fi
.RE
.P
This will validate the data structure and show you possible errors\. This may be used every time
after something is changed\.
.P
\fBPreparse and transform data structure:\fR
.P
.RS 2
.nf
validator \-\-input <file\-or\-dir> \-\-schema <file> \-\-output <json\-file>
.fi
.RE
.P
After validation and optimization the resulting data structure will be written as JSON file to
be easily and fast imported in the program\.
.P
Options:
.P
.RS 2
.nf
\-\-input, \-i     file or directory to read data from       [string] [mandatory]
\-\-schema, \-s    schema to use for validation              [string] [mandatory]
\-\-output, \-o    file to write resulting data structure to             [string]
\-\-force, \-f     force recreating configuration also if up to date    [boolean]
.fi
.RE
.P
General Options:
.P
.RS 2
.nf
\-\-verbose, \-v   run in verbose mode (multiple makes more verbose)      [count]
\-\-quiet, \-q     don't output header and footer                       [boolean]
\-\-nocolors, \-C  turn of color output                                 [boolean]
\-\-help, \-h      Show help                                            [boolean]
.fi
.RE
.P
You may use environment variables prefixed with 'BUILDER_' to set any of
the options like 'BUILDER_VERBOSE' to set the verbose level\.
.SH Benefit of CLI Use
.P
You may always directly load and validate the data structure in your application but it gives you
more speed and less memory use to call it through CLI before\.
.RS 0
.IP \(bu 2
CLI only transforms if source is changed
.IP \(bu 2
no pollution of application memory
.IP \(bu 2
transform may be called on demand manually
.IP \(bu 2
highest performance in config reading
.IP \(bu 2
easy import/require like js modules

.RE
.SH Documentation
.P
See the online documentation \fIhttps://alinex\.gitbooks\.io/validator\fR for more information and also
how to setup the schema and use of API\.
.SH License
.P
(C) Copyright 2014\-2017 Alexander Schilling
.P
Licensed under the Apache License, Version 2\.0 (the "License");
you may not use this file except in compliance with the License\.
You may obtain a copy of the License at
.QP
.P
 http://www\.apache\.org/licenses/LICENSE\-2\.0

.
.P
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied\.
See the License for the specific language governing permissions and
limitations under the License\.