doc: Update doc accordingly

aristanetworks · Nov 16, 2023 · bc4689e · bc4689e
1 parent 63c818c
commit bc4689e
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 8 deletions.
diff --git a/anta/cli/get/commands.py b/anta/cli/get/commands.py
@@ -78,7 +78,7 @@ def from_cvp(inventory_directory: str, cvp_ip: str, cvp_username: str, cvp_passw
 @click.option("--ansible-group", "-g", help="Ansible group to filter", type=str, required=False, default="all")
 @click.option(
     "--ansible-inventory",
-    "-i",
+    "-ai",
     default=None,
     help="Path to your ansible inventory file to read",
     type=click.Path(file_okay=True, dir_okay=False, exists=True, path_type=Path),

diff --git a/docs/cli/inv-from-ansible.md b/docs/cli/inv-from-ansible.md
@@ -17,15 +17,14 @@ Usage: anta get from-ansible [OPTIONS]
   Build ANTA inventory from an ansible inventory YAML file
 
 Options:
-  -g, --ansible-group TEXT        Ansible group to filter
-  -i, --ansible-inventory FILENAME
-                                  Path to your ansible inventory file to read
-  -o, --output FILENAME           Path to save inventory file
-  -d, --inventory-directory PATH  Directory to save inventory file
-  --help                          Show this message and exit.
+  -g, --ansible-group TEXT       Ansible group to filter
+  -ai, --ansible-inventory FILE  Path to your ansible inventory file to read
+  -o, --output FILE              Path to save inventory file. If not
+                                 configured, use anta inventory file
+  --help                         Show this message and exit.
 ```
 
-The output is an inventory where the name of the container is added as a tag for each host:
+The output is an inventory where the name of the container is added as a tag for each host. By default, anta cli saves output in anta inventory configured under `anta --inventory` and can be overwritten with `--output` option:
 
 ```yaml
 anta_inventory: