Skip to content

Commit

Permalink
Update README with new --help output, prepare for 6.0.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
cblakkan committed Jan 2, 2025
1 parent 29d7dda commit a90c7e8
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,25 +54,26 @@ looking up the directory tree until it finds one. If Yamale can not find a schem

Usage:

```bash
```
usage: yamale [-h] [-s SCHEMA] [-e PATTERN] [-p PARSER] [-n CPU_NUM] [-x] [-v] [-V] [PATH ...]
Validate yaml files.
positional arguments:
PATH paths to validate, either directories or files. Default is the current directory.
PATH Paths to validate, either directories or files. Default is the current directory.
options:
-h, --help show this help message and exit
-s SCHEMA, --schema SCHEMA
filename of schema. Default is schema.yaml.
-e PATTERN, --exclude PATTERN
Python regex used to exclude files from validation. Any substring match of a files absolute path will be excluded. Uses deafult Python3 regex. Option can be supplied multiple times.
Python regex used to exclude files from validation. Any substring match of a file's absolute path will be excluded. Uses
default Python3 regex. Option can be supplied multiple times.
-p PARSER, --parser PARSER
YAML library to load files. Choices are "ruamel" or "pyyaml" (default).
-n CPU_NUM, --cpu-num CPU_NUM
number of child processes to spawn for validation. Default is 4. 'auto' to use CPU count.
-x, --no-strict disable strict mode, unexpected elements in the data will be accepted.
Number of child processes to spawn for validation. Default is 4. 'auto' to use CPU count.
-x, --no-strict Disable strict mode, unexpected elements in the data will be accepted.
-v, --verbose show verbose information
-V, --version show program's version number and exit
```
Expand Down
2 changes: 1 addition & 1 deletion yamale/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
5.3.0
6.0.0

0 comments on commit a90c7e8

Please sign in to comment.