Docs: README and quickstart say DiffCI "sends nothing by default", but usage counting is on by default

Open
#286 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

@FredApps is already working on this.

Since Nov 17, 2026.

  • #287 by @FredApps — open

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
typescript
Domain
documentation

Research direction

Update the four quoted statements in README.md and docs/using-diffci.md to distinguish usage counting from code and report uploads, and link to docs/telemetry.md. Read the telemetry sections in those docs first. Done means all four statements accurately describe the defaults; issue 287 is already an open linked pull request.

Written by the indexing model from the issue text.

Description

Four places in the docs say DiffCI "sends nothing by default", but the CLI counts runs by default and sends that count with the repository name:

  • README.md intro: "MIT licensed, runs locally, sends nothing by default"
  • README.md MCP server section: "It needs no account and sends nothing by default."
  • README.md GitHub Action section: "diffci check ... writes reports outside the checkout, and sends nothing by default."
  • docs/using-diffci.md "Check selection and runtime": "DiffCI writes its reports outside the repository and sends nothing by default."

What the code does (main @ 40aa308)

  • packages/diffci-cli/src/client/cli.ts calls recordUsage() after plan (L176), verify (L672), check (L923) and observe (L1064).
  • recordUsage() in telemetry.ts sends a diffci.usage.v1 event to https://app.diffci.com/v1/usage-events unless DO_NOT_TRACK=1, DIFFCI_NO_SEND=1 or DIFFCI_SHARE_USAGE=0 is set. In the default repo mode the event carries repository (host/owner/repo).
  • The MCP server runs cli.js with DIFFCI_MCP=1 (mcp.ts L194), so its runs are counted too, with surface: "local-mcp".

The same README contradicts itself a few sections later ("The diffci CLI, the GitHub Action and the MCP server count runs with the repository name"), and docs/telemetry.md and the telemetry section of docs/using-diffci.md describe the count correctly ("Usage counting is on by default"). What is true by default is that no code and no report is uploaded; --no-send and the missing --api-url/--api-token cover reports only.

Expected: the four sentences say what is actually true: reports and code are not uploaded by default, a usage count is, and they link to docs/telemetry.md. Someone who reads only the README intro or the quickstart should not come away thinking nothing leaves the machine.

DiffCI version: CLI 0.3.54 (packages/diffci-cli on main). Docs-only; no behavior change proposed.

Dominant language
TypeScript
Stars
0
Forks
4
Avg merge
18h 41m
Merged PRs (30d)
48

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from DiffCI/core

All issues in DiffCI/core

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.