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

Offen
#286 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

@FredApps arbeitet bereits daran.

Seit 17.11.2026.

  • #287 von @FredApps — offen

Bewertung

Schwierigkeit
1/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
25/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Veraltet
Tech-Stack
typescript
Bereich
documentation

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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.

Vorherrschende Sprache
TypeScript
Sterne
0
Forks
4
Ø Merge
18 Std. 41 Min.
Gemergte PRs (30 T.)
48

Entwicklungsumgebung

In Codespaces öffnen

Startet den Dev-Container des Projekts im Browser, mit Ihrem eigenen GitHub-Konto.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus DiffCI/core

Alle Issues in DiffCI/core

Ähnliche Issues

Weitere Issues zu TypeScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.