> ## Documentation Index
> Fetch the complete documentation index at: https://www.onyxresearch.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI Analytics and Privacy

> What the Onyx CLI collects, what it excludes, and how to opt out.

Official Onyx CLI releases use PostHog Cloud US to collect structured product
analytics from the first eligible command. The first eligible interactive
command also prints a one-time telemetry notice describing collection and how
to opt out; the notice is informational and does not gate collection.
Collection is best effort and never changes command behavior or exit status.

## What may be collected

At most one terminal outcome is recorded for each allowlisted, user-invoked
command. It may contain:

* a bounded command name, such as `setup.validate` or `research.run`;
* success, expected error, unexpected error, interruption, or timeout;
* rounded duration and a stable failure stage/reason code;
* CLI version, official-distribution marker, and auth state; and
* internal user and team UUIDs after login, or a random installation UUID
  before login.

Starting and ending the interactive `onyx listen` TUI and bounded setup
validation/preflight outcomes may also be recorded. Rendering, key presses,
rows, and polling are never recorded. Installation history is never aliased to
a user after login.

Failure stages are restricted to `auth`, `configuration`, `setup`, `git`,
`provider`, `model`, `protocol`, `network`, `api`, `execution`, `interruption`,
or `unknown`. Reason codes are restricted to authentication, invalid
configuration/setup/Git/model/protocol, provider availability, network/API,
usage, timeout, interruption, unexpected-throw, and generic command-failure
categories. The CLI never sends the underlying error message.

## What is never collected

CLI analytics does not send command arguments, environment variables, local
paths, repository names or URLs, refs, commit SHAs, source code, diffs, prompts,
model output, hypotheses, descriptions, notes, knowledge, metric names or
values, credentials, headers, request/response bodies, arbitrary error text,
worker output, heartbeats, presence, provider logs, or arbitrary JSON.

`onyx-worker`, worker environments, synthetic workers, testbed sessions, CI,
source/developer builds, and non-production API profiles do not collect
analytics.

## Controls

```bash theme={"theme":{"light":"github-dark-dimmed","dark":"github-dark-dimmed"}}
onyx telemetry status
onyx telemetry disable
onyx telemetry enable
```

For an environment-level opt-out, set either variable:

```bash theme={"theme":{"light":"github-dark-dimmed","dark":"github-dark-dimmed"}}
export ONYX_TELEMETRY_DISABLED=1
# or
export DO_NOT_TRACK=1
```

Retention follows the active PostHog account and project settings. For access
or deletion requests, contact [support@onyxresearch.ai](mailto:support@onyxresearch.ai). Browser analytics uses
its own immediate PostHog collection and is not controlled by the CLI setting.