diff options
Diffstat (limited to 'docs/cli/check.md')
| -rw-r--r-- | docs/cli/check.md | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/docs/cli/check.md b/docs/cli/check.md index d7dea62..c230722 100644 --- a/docs/cli/check.md +++ b/docs/cli/check.md @@ -1,11 +1,12 @@ +--- +anta_title: ANTA check commands +--- <!-- ~ Copyright (c) 2023-2024 Arista Networks, Inc. ~ Use of this source code is governed by the Apache License 2.0 ~ that can be found in the LICENSE file. --> -# ANTA check commands - The ANTA check command allow to execute some checks on the ANTA input files. Only checking the catalog is currently supported. @@ -27,10 +28,12 @@ Commands: ```bash Usage: anta check catalog [OPTIONS] - Check that the catalog is valid + Check that the catalog is valid. Options: - -c, --catalog FILE Path to the test catalog YAML file [env var: - ANTA_CATALOG; required] - --help Show this message and exit. + -c, --catalog FILE Path to the test catalog file [env var: + ANTA_CATALOG; required] + --catalog-format [yaml|json] Format of the catalog file, either 'yaml' or + 'json' [env var: ANTA_CATALOG_FORMAT] + --help Show this message and exit. ``` |