Setup

Get AI telemetry flowing in under 5 minutes using the flowstate-telemetry CLI.

Prerequisites

• macOS (ARM/x64) or Linux (x64)
• A Flowstate account with AI Telemetry enabled
• A telemetry API key (generate one from your Profile → AI Telemetry section, or ask your admin to bulk-generate keys from AI Workforce → Telemetry Keys)

Install the CLI

macOS (Homebrew):

brew tap meetflowstate/tap && brew install flowstate-telemetry

Linux / manual download:

Download the latest binary from GitHub releases.

Set Your Key

Set your telemetry key as an environment variable:

export FLOWSTATE_OTLP_KEY="YOUR_TELEMETRY_KEY"

Or pass it as a flag with --key YOUR_TELEMETRY_KEY on any command.

Configure All Tools

The fastest way to set up telemetry for every supported AI tool on your machine:

flowstate-telemetry install --all

This auto-detects installed AI tools and configures each one to send telemetry to Flowstate. It also writes environment variables to your shell profile (~/.zshrc or ~/.bashrc).

Configure a Single Tool

flowstate-telemetry install --tool claude-code

Available --tool values: claude-code, copilot-chat, cursor, windsurf, gemini-cli, codex-cli, aider, qwen-code, opencode

Enable Prompt Capture

WARNING

Prompt capture sends the text of your prompts to Flowstate for classification. For some tools this is opt-in via the --prompts flag; for others it is always on.

flowstate-telemetry install --all --prompts

Behaviour	Tools
Opt-in (--prompts flag)	Claude Code, Copilot Chat, Gemini CLI, Codex CLI, Qwen Code
Always on (no toggle)	Cursor, Windsurf, Aider, OpenCode

Tools with "always on" prompt capture send prompt content by default when telemetry is configured — there is no separate opt-in step.

CLI Commands Reference

Command	Description
install --all	Configure all detected AI tools
install --tool <name>	Configure a specific tool
remove --all	Remove telemetry configuration from all tools
remove --tool <name>	Remove configuration from a specific tool
status	Show configuration status of all tools
verify	Check if telemetry configuration is correct
generate-mdm --format <fmt>	Generate MDM deployment artefacts (jamf, intune, ansible, puppet)

Global Flags

Flag	Description	Environment Variable
--key <key>	Flowstate telemetry API key	FLOWSTATE_OTLP_KEY
--endpoint <url>	OTel collector endpoint	FLOWSTATE_OTLP_ENDPOINT
--verbose	Enable debug logging	—

Install Flags

Flag	Description
--all	Install for all detected tools
--tool <name>	Install for a specific tool
--prompts	Enable prompt capture (where supported)
--dry-run	Preview changes without writing files

Manual Setup

If you prefer to configure tools manually (without the CLI), see the individual tool guides:

• Claude Code · GitHub Copilot · Cursor · Windsurf
• Gemini CLI · Codex CLI · Aider · Qwen Code · OpenCode

Next Steps

After setup, verify data is flowing.