update readme

netascode · Oct 22, 2024 · b792380 · b792380
1 parent 39b554b
commit b792380
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -21,15 +21,30 @@ pip3 install .
 ```cli
 Usage: nac-collector [OPTIONS]
 
+  A CLI tool to collect various network configurations.
+
 Options:
-  -s, --solution [SDWAN|ISE]  Solutions supported [SDWAN, ISE]  [required]
-  -u, --username TEXT         Username for authentication  [required]
-  -p, --password TEXT         Password for authentication  [required]
-  -url, --url TEXT            Base URL for the service  [required]
-  -v, --verbose               Enable verbose output
-  -g, --git-provider          Generate endpoint.yaml automatically using
-                              provider github repo
-  --help                      Show this message and exit.
+  --version                       Show the version and exit.
+  -v, --verbosity LVL             Either CRITICAL, ERROR, WARNING, INFO or
+                                  DEBUG
+  -s, --solution [SDWAN|ISE|NDO|FMC]
+                                  Solutions supported [SDWAN, ISE, NDO, FMC]
+                                  [required]
+  -u, --username TEXT             Username for authentication. Can also be set
+                                  using the NAC_USERNAME environment variable
+                                  [required]
+  -p, --password TEXT             Password for authentication. Can also be set
+                                  using the NAC_PASSWORD environment variable
+                                  [required]
+  -url, --url TEXT                Base URL for the service. Can also be set
+                                  using the NAC_URL environment variable
+                                  [required]
+  -g, --git-provider              Generate endpoint.yaml automatically using
+                                  provider github repo
+  -e, --endpoints-file TEXT       Path to the endpoints YAML file
+  -t, --timeout INTEGER           Request timeout in seconds. Default is 30.
+  -o, --output TEXT               Path to the output json file
+  -h, --help                      Show this message and exit.
 ```
 
 Set environment variables pointing to supported solution instance:

diff --git a/nac_collector/cli/options.py b/nac_collector/cli/options.py
@@ -57,6 +57,7 @@
 
 timeout = click.option(
     "--timeout",
+    "-t",
     type=int,
     help=f"Request timeout in seconds. Default is {TIMEOUT}.",
     default=TIMEOUT,