Telemetry
What the Rayfin CLI collects, what it explicitly does not, and how to opt out with RAYFIN_TELEMETRY_OPTOUT.
The Rayfin CLI collects anonymous usage data to help improve the product. On first run, it prints a notice explaining what's collected and how to opt out.
What's collected
- Command names.
- Which flags were passed, by name only (for example
--force,-v) — never their values. - Execution status (success/failure), and on failure, a sanitized error name/type/message with file paths and stack traces stripped out.
- Execution duration.
- Environment metadata: OS and Node.js version.
What's not collected
No personal data, flag values, or file contents are collected — arguments you pass (project names, workspace names, connection strings, file paths) are never sent, only the fact that a given flag was used.
Opt out
export RAYFIN_TELEMETRY_OPTOUT=1Set this in your shell profile to opt out permanently, or inline for a single invocation.
Telemetry endpoint override
RAYFIN_APPINSIGHTS_CONNECTION_STRING overrides the telemetry endpoint used by the CLI and
the VS Code extension. This is a contributor/internal setting, not something most projects
need to set. See
Environment variables for the full
shell-only variable reference.
Add RAYFIN_TELEMETRY_OPTOUT=1 to my CI workflow's environment variables so the Rayfin CLI
doesn't send usage telemetry from automated runs.Templates
Where Rayfin project templates come from — built-in, git, and local sources, registering your own template sources, and authoring a template.
Configuration
Landing page for Rayfin configuration reference — rayfin.yml schema, the exhaustive environment variable table, and ${VAR} interpolation syntax.