Skip to content

cli: docs improvements #178

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aviau merged 1 commit into from
Feb 7, 2026
Merged

cli: docs improvements #178

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/changelog/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,15 @@ This page lists changes to Flare's API.
Release notes for the Flare Platform can be found on the [product documentation website](https://docs.flare.io/releases).
</Note>

<Update label="2026-02" description="CLI - February 2026">
Released the beta of the
[Flare API CLI <Icon icon="book" size={16} />](/sdk/cli)
utility.

This new command line interface (CLI) program provides Flare API automations such as
exporting tenant events or credentials to CSV files.
</Update>

<Update label="2026-02" description="API - February 2026">
Published a new
[List and Update Identifiers <Icon icon="book" size={16} />](/guides/update-identifiers)
Expand Down
39 changes: 32 additions & 7 deletions docs/sdk/cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,22 +21,47 @@ However, we recommend that you invoke it using [uv](https://docs.astral.sh/uv/).
# Running the last version
uvx flareio-cli --help

# Running a specific version
# Running a specific version. This ensures CLI stability.
uvx flareio-cli@version --help
```

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

## Exporting Tenant Events
## Configuration

You may export a tenant's events using the `export-tenant-feed` command:
- The output will be written to `output.txt`.
Most commands will require exporting environment variables `FLARE_API_KEY` and `FLARE_TENANT_ID`:
```bash
export FLARE_API_KEY="<api-key>"
export FLARE_TENANT_ID="<tenant-id>"
```

## Usage Examples

### 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.

```bash
export FLARE_API_KEY="<api-key>"
uvx run flareio-cli export-tenant-feed \
uvx flareio-cli export-tenant-feed \
--cursor-file=cursor.txt \
--output-file=output.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.

```bash
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](https://github.com/Flared/flareio-cli/issues).