From f47c1a9efb59a5ffcbeaa80fbff4ec277b20999d Mon Sep 17 00:00:00 2001 From: aviau Date: Fri, 6 Feb 2026 20:08:33 -0500 Subject: [PATCH 1/2] initial cli docs --- docs/docs.json | 3 ++- docs/sdk/cli.mdx | 41 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 43 insertions(+), 1 deletion(-) create mode 100644 docs/sdk/cli.mdx diff --git a/docs/docs.json b/docs/docs.json index 5394f69..9978153 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -29,10 +29,11 @@ ] }, { - "group": "SDK & MCP", + "group": "SDK, MCP & CLI", "pages": [ "sdk/python", "sdk/go", + "sdk/cli", "sdk/mcp" ] }, diff --git a/docs/sdk/cli.mdx b/docs/sdk/cli.mdx new file mode 100644 index 0000000..1d4ab2a --- /dev/null +++ b/docs/sdk/cli.mdx @@ -0,0 +1,41 @@ +--- +title: "CLI (beta)" +--- + + +The CLI utility is still in beta and is subject to change. + + +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. + +## Running directly with uvx + +We recommend that you run `flareio-cli` using [uv](https://docs.astral.sh/uv/). + +```bash +uvx flareio-cli --help +``` + +## Installing - PIP + +You may install the CLI using pip with the following command: + +```bash +pip install flareio-cli +``` + + +## Exporting Tenant Events + +You may export a tenant's events using the `export-tenant-feed` command: +- The output will be written to `output.txt`. +- 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 \ + --cursor-file=cursor.txt \ + --output-file=output.txt \ + --from-date=2025-01-01 +``` From f6997652f2719328623539a007c5a915825c1088 Mon Sep 17 00:00:00 2001 From: aviau Date: Fri, 6 Feb 2026 20:11:00 -0500 Subject: [PATCH 2/2] cli: releases --- docs/sdk/cli.mdx | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/sdk/cli.mdx b/docs/sdk/cli.mdx index 1d4ab2a..e1677c8 100644 --- a/docs/sdk/cli.mdx +++ b/docs/sdk/cli.mdx @@ -9,14 +9,20 @@ The CLI utility is still in beta and is subject to change. 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. -## Running directly with uvx +## Running directly with `uvx` We recommend that you run `flareio-cli` using [uv](https://docs.astral.sh/uv/). ```bash +# Running the last version uvx flareio-cli --help + +# Running a specific version +uvx flareio-cli@version --help ``` +You may find all available version on the [releases](https://github.com/Flared/flareio-cli/releases) page. + ## Installing - PIP You may install the CLI using pip with the following command: