-
Notifications
You must be signed in to change notification settings - Fork 71
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: update usage to cobra format and commands to use
--
- Loading branch information
Showing
3 changed files
with
66 additions
and
62 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -91,28 +91,28 @@ go install github.com/Boeing/config-file-validator/cmd/[email protected] | |
|
||
## Usage | ||
``` | ||
Usage: validator [OPTIONS] [<search_path>...] | ||
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 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -111,28 +111,28 @@ go install github.com/Boeing/config-file-validator/cmd/[email protected] | |
|
||
## Usage | ||
``` | ||
Usage: validator [OPTIONS] [<search_path>...] | ||
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 | ||
|