Skip to main content
The CLI utility is still in beta and is subject to change.
Flare publishes a CLI interface for interacting with the Flare API. It automates basic tasks such exporting events to output files.

​
Installing

flareio-cli is available on PyPI, you can install it using: 
pip install flareio-cli
However, we recommend that you invoke it using uv. Example: 
# Running the last version
uvx flareio-cli --help

# Running a specific version. This ensures CLI stability.
uvx flareio-cli@version --help
You may find all available versions on the Github releases page.

​
Configuration

Most commands will require exporting environment variables FLARE_API_KEY and FLARE_TENANT_ID: 
export FLARE_API_KEY="<api-key>"
export FLARE_TENANT_ID="<tenant-id>"

​
Features

​
Discovering Commands

You may discover all commands using help: 
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.
  • The cursor.txt file can be used to resume the export from the last place it stopped.
uvx flareio-cli export-tenant-feed \
    --cursor-file=cursor.txt \
    --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.
  • The cursor.txt file can be used to resume the export from the last place it stopped.
uvx flareio-cli export-tenant-credentials \
    --cursor-file=cursor.txt \
    --output-file=output.csv

​
Feedback

The flareio-cli project is still considered beta. Feedback may be directed to the Github Project issues.