Docs: README and quickstart say DiffCI "sends nothing by default", but usage counting is on by default
Maintainers usually reply within 1 day
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.mdintro: "MIT licensed, runs locally, sends nothing by default"README.mdMCP server section: "It needs no account and sends nothing by default."README.mdGitHub 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.tscallsrecordUsage()afterplan(L176),verify(L672),check(L923) andobserve(L1064).recordUsage()intelemetry.tssends adiffci.usage.v1event tohttps://app.diffci.com/v1/usage-eventsunlessDO_NOT_TRACK=1,DIFFCI_NO_SEND=1orDIFFCI_SHARE_USAGE=0is set. In the defaultrepomode the event carriesrepository(host/owner/repo).- The MCP server runs
cli.jswithDIFFCI_MCP=1(mcp.tsL194), so its runs are counted too, withsurface: "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
Starts the project's dev container in your browser, under your own GitHub account.
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from DiffCI/core
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Planner: splitParts regex is quadratic on a quote followed by many backticks, so the fuzz test fails at randomPossibly taken @FredApps claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
Maintainers usually reply within 1 day
-
Agent tools: changed_files lists only the new path of a renamed filePossibly taken @FredApps claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
adapter good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Maintainers usually reply within 1 day
Similar issues
-
agent-ready area: ui-server priority: p3 type: test
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
schlessera/brain-kit#4249 ·
Maintainers usually reply within 1 day
-
documentation tool triaged
Difficulty 2/5 1-3 hours Newbie friendliness 73/100
can1357/oh-my-pi#19608 · 2 comments ·
Maintainers usually reply within 1 day
-
dependencies tech-debt
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
bcgov/nr-waste-plus#1549 ·
Maintainers usually reply within 1 day
-
enhancement good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
blixvip/solana-token-meta#17 ·
-
enhancement good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
blixvip/solana-tx-parse#18 ·