summaryrefslogtreecommitdiffstats
path: root/docs/cli/check.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/cli/check.md')
-rw-r--r--docs/cli/check.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/docs/cli/check.md b/docs/cli/check.md
new file mode 100644
index 0000000..d7dea62
--- /dev/null
+++ b/docs/cli/check.md
@@ -0,0 +1,36 @@
+<!--
+ ~ 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.
+
+```bash
+anta check --help
+Usage: anta check [OPTIONS] COMMAND [ARGS]...
+
+ Check commands for building ANTA
+
+Options:
+ --help Show this message and exit.
+
+Commands:
+ catalog Check that the catalog is valid
+```
+
+## Checking the catalog
+
+```bash
+Usage: anta check catalog [OPTIONS]
+
+ 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.
+```