diff --git a/README.md b/README.md index 58d720ef..34f3d36a 100644 --- a/README.md +++ b/README.md @@ -91,28 +91,28 @@ go install github.com/Boeing/config-file-validator/cmd/validator@v1.6.0 ## Usage ``` -Usage: validator [OPTIONS] [...] - -positional arguments: - search_path: The search path on the filesystem for configuration files. Defaults to the current working directory if no search_path provided. Multiple search paths can be declared separated by a space. - -optional flags: - -depth int - Depth of recursion for the provided search paths. Set depth to 0 to disable recursive path traversal - -exclude-dirs string - Subdirectories to exclude when searching for configuration files - -exclude-file-types string - A comma separated list of file types to ignore - -output string - Destination to a file to output results - -quiet - If quiet flag is set. It doesn't print any output to stdout. - -groupby string - Group the output by filetype, pass-fail, or directory. Supported Reporters are Standard and JSON - -reporter string - Format of the printed report. Options are standard and json (default "standard") - -version - Version prints the release version of validator +Cross Platform tool to validate configuration files + +Usage: + validator [flags] + validator [command] + +Available Commands: + completion Generate the autocompletion script for the specified shell + help Help about any command + version Version prints the release version of validator + +Flags: + --depth int Depth of recursion for the provided search paths. Set depth to 0 to disable recursive path traversal. + --exclude-dirs string Subdirectories to exclude when searching for configuration files + --exclude-file-types string A comma separated list of file types to ignore + --groupby string Group output by filetype, directory, pass-fail. Supported for Standard and JSON reports + -h, --help help for validator + --output string Destination to a file to output results + --quiet If quiet flag is set. It doesn't print any output to stdout. + --reporter string Format of the printed report. Options are standard and json (default "standard") + +Use "validator [command] --help" for more information about a command. ``` ### Examples diff --git a/cmd/validator/validator.go b/cmd/validator/validator.go index 88549453..b0e671bf 100644 --- a/cmd/validator/validator.go +++ b/cmd/validator/validator.go @@ -5,24 +5,28 @@ validates them using the go package for each configuration type. Currently Apple PList XML, CSV, HCL, HOCON, INI, JSON, Properties, TOML, XML, and YAML. configuration file types are supported. -Usage: [OPTIONS] [...] - -positional arguments: - search_path: The search path on the filesystem for configuration files. Defaults to the current working directory if no search_path provided. Multiple search paths can be declared separated by a space. - -optional flags: - -depth int - Depth of recursion for the provided search paths. Set depth to 0 to disable recursive path traversal - -exclude-dirs string - Subdirectories to exclude when searching for configuration files - -exclude-file-types string - A comma separated list of file types to ignore - -output - Destination of a file to outputting results - -reporter string - Format of the printed report. Options are standard and json (default "standard") - -version - Version prints the release version of validator +Cross Platform tool to validate configuration files + +Usage: + validator [flags] + validator [command] + +Available Commands: + completion Generate the autocompletion script for the specified shell + help Help about any command + version Version prints the release version of validator + +Flags: + --depth int Depth of recursion for the provided search paths. Set depth to 0 to disable recursive path traversal. + --exclude-dirs string Subdirectories to exclude when searching for configuration files + --exclude-file-types string A comma separated list of file types to ignore + --groupby string Group output by filetype, directory, pass-fail. Supported for Standard and JSON reports + -h, --help help for validator + --output string Destination to a file to output results + --quiet If quiet flag is set. It doesn't print any output to stdout. + --reporter string Format of the printed report. Options are standard and json (default "standard") + +Use "validator [command] --help" for more information about a command. */ package cmd diff --git a/index.md b/index.md index ff89e32d..6453599d 100644 --- a/index.md +++ b/index.md @@ -111,28 +111,28 @@ go install github.com/Boeing/config-file-validator/cmd/validator@v1.6.0 ## Usage ``` -Usage: validator [OPTIONS] [...] - -positional arguments: - search_path: The search path on the filesystem for configuration files. Defaults to the current working directory if no search_path provided. Multiple search paths can be declared separated by a space. - -optional flags: - -depth int - Depth of recursion for the provided search paths. Set depth to 0 to disable recursive path traversal - -exclude-dirs string - Subdirectories to exclude when searching for configuration files - -exclude-file-types string - A comma separated list of file types to ignore - -groupby string - Group output by filetype, directory, pass-fail. Supported for Standard and JSON reports - -output string - Destination to a file to output results - -quiet - If quiet flag is set. It doesn't print any output to stdout. - -reporter string - Format of the printed report. Options are standard and json (default "standard") - -version - Version prints the release version of validator +Cross Platform tool to validate configuration files + +Usage: + validator [flags] + validator [command] + +Available Commands: + completion Generate the autocompletion script for the specified shell + help Help about any command + version Version prints the release version of validator + +Flags: + --depth int Depth of recursion for the provided search paths. Set depth to 0 to disable recursive path traversal. + --exclude-dirs string Subdirectories to exclude when searching for configuration files + --exclude-file-types string A comma separated list of file types to ignore + --groupby string Group output by filetype, directory, pass-fail. Supported for Standard and JSON reports + -h, --help help for validator + --output string Destination to a file to output results + --quiet If quiet flag is set. It doesn't print any output to stdout. + --reporter string Format of the printed report. Options are standard and json (default "standard") + +Use "validator [command] --help" for more information about a command. ``` ### Examples