Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion docs/docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,11 @@
]
},
{
"group": "SDK & MCP",
"group": "SDK, MCP & CLI",
"pages": [
"sdk/python",
"sdk/go",
"sdk/cli",
"sdk/mcp"
]
},
Expand Down
47 changes: 47 additions & 0 deletions docs/sdk/cli.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
title: "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.

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

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