Skip to content

docs(telemetry): document PostHog analytics and opt-out mechanisms in README#182

Open
xiaolai wants to merge 1 commit intocaliber-ai-org:masterfrom
xiaolai:fix/nlpm-telemetry-disclosure
Open

docs(telemetry): document PostHog analytics and opt-out mechanisms in README#182
xiaolai wants to merge 1 commit intocaliber-ai-org:masterfrom
xiaolai:fix/nlpm-telemetry-disclosure

Conversation

@xiaolai
Copy link
Copy Markdown

@xiaolai xiaolai commented Apr 20, 2026

Automated audit: This PR was generated by NLPM, a natural language programming linter, running via claude-code-action. Please evaluate the diff on its merits.

Issue

The README FAQ answer to "Does it send my code anywhere?" mentioned that anonymous usage analytics "can be disabled via caliber config", but did not:

  1. Name the third-party analytics provider (PostHog, listed as a production dependency in package.json)
  2. Document the specific opt-out mechanisms already built into the codebase

The existing src/telemetry/config.ts already implements two opt-out methods:

  • --no-traces CLI flag (sets runtimeDisabled = true for that run)
  • CALIBER_TELEMETRY_DISABLED=1 environment variable (persistent)

Fix

Updated the FAQ answer to:

  • Name PostHog explicitly as the analytics provider
  • List both opt-out methods with the exact commands users need

No code changes — documentation only. The opt-out mechanisms were already implemented; this just makes them discoverable.

Note: there is already a branch alonp98/fix-146-telemetry-opt-in in this repo that may address related concerns. This PR is narrowly scoped to README disclosure only, so it shouldn't conflict.

… README

The FAQ answer about data collection mentioned that analytics "can be
disabled via caliber config" but did not disclose that PostHog is the
analytics provider, nor document the specific opt-out mechanisms already
implemented in the codebase:

- --no-traces CLI flag (per-run)
- CALIBER_TELEMETRY_DISABLED=1 env var (persistent)

Updated the FAQ to name PostHog explicitly and list both opt-out methods
so users can make an informed choice without reading source code.

Co-Authored-By: Claude Code <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant