diff options
Diffstat (limited to 'docs/getting-started.md')
| -rw-r--r-- | docs/getting-started.md | 16 |
1 files changed, 12 insertions, 4 deletions
diff --git a/docs/getting-started.md b/docs/getting-started.md index 4386485..bab1cea 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -13,7 +13,7 @@ This section shows how to use ANTA with basic configuration. All examples are ba The easiest way to install ANTA package is to run Python (`>=3.9`) and its pip package to install: ```bash -pip install anta +pip install anta[cli] ``` For more details about how to install package, please see the [requirements and installation](./requirements-and-installation.md) section. @@ -121,6 +121,14 @@ anta.tests.configuration: ## Test your network +### Basic usage in a python script + +```python +--8<-- "anta_runner.py" +``` + +### CLI + ANTA comes with a generic CLI entrypoint to run tests in your network. It requires an inventory file as well as a test catalog. This entrypoint has multiple options to manage test coverage and reporting. @@ -135,7 +143,7 @@ This entrypoint has multiple options to manage test coverage and reporting. To run the NRFU, you need to select an output format amongst ["json", "table", "text", "tpl-report"]. For a first usage, `table` is recommended. By default all test results for all devices are rendered but it can be changed to a report per test case or per host -### Default report using table +#### Default report using table ```bash anta nrfu \ @@ -176,7 +184,7 @@ anta nrfu \ └───────────┴──────────────────────────┴─────────────┴──────────────────┴──────────────────────────────────────────────────────────────────────┴───────────────┘ ``` -### Report in text mode +#### Report in text mode ```bash $ anta nrfu \ @@ -206,7 +214,7 @@ leaf01 :: VerifyMlagConfigSanity :: SKIPPED (MLAG is disabled) [...] ``` -### Report in JSON format +#### Report in JSON format ```bash $ anta nrfu \ |