Metadata-Version: 2.3
Name: flareio-cli
Version: 0.7.4
Summary: CLI interface for the flare.io API.
Keywords: flare,sdk,cli
Author: Alexandre Viau
Author-email: Alexandre Viau <alexandre.viau@flare.io>
Classifier: Intended Audience :: Information Technology
Classifier: Environment :: Console
Classifier: Operating System :: POSIX :: Linux
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Security
Classifier: Typing :: Typed
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: flareio>=2.1.0
Requires-Dist: pydantic>=2.12.5
Requires-Dist: typer>=0.21.1
Requires-Python: >=3.9
Description-Content-Type: text/markdown

# flareio-cli

`flareio-cli` is a beta CLI interface for the [flare.io API](https://api.docs.flare.io/).

The [full CLI documentation](https://api.docs.flare.io/sdk/cli) can be found on Flare's API documentation website.

## Changelog & Releases

You may find the [changelog and all available versions](https://github.com/Flared/flareio-cli/releases) on the Github releases page.

## Installing

`flareio-cli` is [available on PyPI](https://pypi.org/project/flareio-cli/).

Invoke it directly using [uv](https://docs.astral.sh/uv/) (recommended):
```bash
# Running the most recent version.
uvx flareio-cli --help

# Running a specific version. Recommended to ensure stability.
# Example: uvx flareio-cli@0.5.0 --help
uvx flareio-cli@version --help
```

Or install it:
```bash
# Using uv
uv tool install flareio-cli

# Using pip
pip install flareio-cli
```

## Usage Example

Export Tenant Feed to CSV file:
```
export FLARE_API_KEY="<api-key>"

uvx run flareio-cli export-tenant-feed \
    --cursor-file=cursor.txt \
    --output-file=output.csv \
    --from-date=2025-01-01
```

Learn more in the [full CLI documentation](https://api.docs.flare.io/sdk/cli).

## Contributing

We recommend the following dependencies:
- `make`
- `uv`
- `direnv`

The `Makefile` contains the following targets:
- `make test` will run tests
- `make check` will run typechecking
- `make format` format will format the code
- `make format-check` will run linting
- `make ci` will run CI equivalent

## Feedback

Do you have ideas or feature requests? Feel free to open issues.
