Metadata-Version: 2.1
Name: flowctl
Version: 0.1.3
Summary: The CLI tool for operation of Flowdapt.
License: MIT
Author: Emergent Methods
Author-email: contact@emergentmethods.ai
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: aiofiles (>=23.2.1,<24.0.0)
Requires-Dist: flowdapt_sdk (>=0.1.1,<0.2.0)
Requires-Dist: humanize (>=4.9.0,<5.0.0)
Requires-Dist: jmespath-community (>=1.1.2,<2.0.0)
Requires-Dist: plotext (>=5.2.8,<6.0.0)
Requires-Dist: python-manifest (>=2.2.1,<3.0.0)
Requires-Dist: rich (>=13.7.0,<14.0.0)
Requires-Dist: typer (>=0.9.0,<0.10.0)
Requires-Dist: typing_extensions (>=4.8.0,<5.0.0)
Description-Content-Type: text/markdown

# flowctl

![GitLab Release (latest by SemVer)](https://img.shields.io/gitlab/v/release/emergentmethods/flowctl?style=flat-square)
![GitLab](https://img.shields.io/gitlab/license/emergentmethods/flowctl?style=flat-square)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/flowctl?style=flat-square)

The CLI tool for managing and operating flowdapt.


## Installation

For normal use users can install flowctl via pip:
```bash
pip install flowctl
```

Or you can use the docker images provided:
```bash
docker run -ti --rm -v "$(pwd)":/data --network host ghcr.io/emergentmethods/flowctl:latest --help
```

If you'd like, you can set an alias for the docker command to make it easier to use. For example, in bash you can add the following to your `.bashrc` or `.bash_profile` file:

```bash
alias flowctl='docker run -ti --rm -v "$(pwd)":/data --network host ghcr.io/emergentmethods/flowctl:latest'
```

Then you can use `flowctl` as if it were installed on your system.

```bash
flowctl --help
```

## Documentation
For documentation on how to use `flowctl`, please see the [CLI Reference](cli.md).

