> ## Documentation Index
> Fetch the complete documentation index at: https://api.docs.flare.io/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI (beta)

<Note>
  The CLI utility is still in beta and is subject to change.
</Note>

Flare publishes a [CLI interface](https://github.com/flared/flareio-cli) for interacting with the Flare API.
It automates basic tasks such exporting events to output files.

## 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 theme={null}
# Running the most recent version.
uvx flareio-cli --help

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

Or install it:

```bash theme={null}
# Using uv
uv tool install flareio-cli

# Using pip
pip install flareio-cli
```

## Configuration

Most commands will require exporting environment variables `FLARE_API_KEY` and `FLARE_TENANT_ID`:

```bash theme={null}
export FLARE_API_KEY="<api-key>"
export FLARE_TENANT_ID="<tenant-id>"
```

## Features

### Discovering Commands

You may discover all commands using `help`:

```bash theme={null}
uvx flareio-cli help
```

### Exporting Tenant Events

You may export a tenant's events to a CSV using the `export-tenant-feed` command:

* The output will be written to `output.csv`.

```bash theme={null}
uvx flareio-cli export-tenant-feed \
    --output-file=output.csv \
    --from-date=2025-01-01
```

### Exporting Tenant Credentials

You may export a tenant's credentials to a CSV using the `export-tenant-credentials` command:

* The output will be written to `output.csv`.

```bash theme={null}
uvx flareio-cli export-tenant-credentials \
    --output-file=output.csv
```

### Exporting Identifier Credentials

You may export an identifier's credentials to a CSV using the `export-identifier-credentials` command:

* The output will be written to `output.csv`.

```bash theme={null}
uvx flareio-cli export-identifier-credentials \
    --identifier-id=123 \
    --output-file=output.csv
```

## Feedback

The `flareio-cli` project is still considered beta.
Feedback may be directed to the [Github project's issues](https://github.com/Flared/flareio-cli/issues).