From c0902420c0b100743e095bc7748de7f6654d2d0c Mon Sep 17 00:00:00 2001 From: aviau Date: Sat, 7 Feb 2026 03:53:27 -0500 Subject: [PATCH] cli: docs improvements --- docs/changelog/overview.mdx | 9 +++++++++ docs/sdk/cli.mdx | 39 ++++++++++++++++++++++++++++++------- 2 files changed, 41 insertions(+), 7 deletions(-) diff --git a/docs/changelog/overview.mdx b/docs/changelog/overview.mdx index 33f5f8e..f613e4e 100644 --- a/docs/changelog/overview.mdx +++ b/docs/changelog/overview.mdx @@ -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). + + Released the beta of the + [Flare API CLI ](/sdk/cli) + utility. + + This new command line interface (CLI) program provides Flare API automations such as + exporting tenant events or credentials to CSV files. + + Published a new [List and Update Identifiers ](/guides/update-identifiers) diff --git a/docs/sdk/cli.mdx b/docs/sdk/cli.mdx index ca858dd..fd08730 100644 --- a/docs/sdk/cli.mdx +++ b/docs/sdk/cli.mdx @@ -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="" +export FLARE_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="" -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).