# Overview

`codestream-cli` is a python script that includes utilities for working with VMware Aria Automation (formerly VMware vRealize Automation).

The primary form of interaction with the utility is via the command-line interface however the modules can be imported into other scripts if required.

The python package is broken down into three main groups of sub-packages.

1. **CLI**: Processing of command-line arguments and options which call the API modules.
2. **API**: Submodules which communicate with the vRA API for a specific resource type.
3. **Other**: Submodules that don't fit into the above groups. Examples include common and docs.

## Installation

`codestream-cli` is available on both [PyPI](https://pypi.org/project/codestream-cli/) and [PyPi Test](https://test.pypi.org/project/codestream-cli/) and can be installed using `pip`:

```bash
# PyPi
pip install codestream-cli

# PyPi Test
pip install -i https://test.pypi.org/simple/ codestream-cli
```

## Walk through

An introduction to `codestream-cli` is available as a walk-through [here](training.md).