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

Aperta
#286 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@FredApps ci sta già lavorando.

Dal 17/11/2026.

  • #287 di @FredApps — aperta

Valutazione

Difficoltà
1/5
Tempo stimato
1-3 ore
Idoneità per principianti
25/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Stack tecnologico
typescript
Ambito
documentation

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
TypeScript
Stelle
0
Fork
4
Merge medio
18h 41m
PR unite (30g)
48

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di DiffCI/core

Tutte le issue di DiffCI/core

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.