Skip to content

Commit 0462a7d

Browse files
phernandezclaude
andcommitted
docs: add telemetry disclosure and opt-out instructions to README
Transparent about what we collect (promo/login events only), what we don't (no PII, no file contents, no per-command tracking), and how to opt out (BASIC_MEMORY_NO_PROMOS=1). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Signed-off-by: phernandez <paul@basicmachines.co>
1 parent 79db876 commit 0462a7d

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -484,6 +484,31 @@ See the [Documentation](https://docs.basicmemory.com) for more info, including:
484484
- [Managing multiple Projects](https://docs.basicmemory.com/guides/cli-reference/#project)
485485
- [Importing data from OpenAI/Claude Projects](https://docs.basicmemory.com/guides/cli-reference/#import)
486486

487+
## Telemetry
488+
489+
Basic Memory collects anonymous, minimal usage events to understand how the CLI-to-cloud conversion funnel performs. This helps us prioritize features and improve the product.
490+
491+
**What we collect:**
492+
- Cloud promo impressions (when the promo banner is shown)
493+
- Cloud login attempts and outcomes
494+
- Promo opt-out events
495+
496+
**What we do NOT collect:**
497+
- No file contents, note titles, or knowledge base data
498+
- No personally identifiable information (PII)
499+
- No IP address tracking or fingerprinting
500+
- No per-command or per-tool-call tracking
501+
502+
Events are sent to our [Umami Cloud](https://umami.is) instance, an open-source, privacy-focused analytics platform. Events are fire-and-forget on a background thread — analytics never blocks or slows the CLI.
503+
504+
**Opt out** by setting the environment variable:
505+
506+
```bash
507+
export BASIC_MEMORY_NO_PROMOS=1
508+
```
509+
510+
This disables both promo messages and all telemetry events.
511+
487512
## Logging
488513

489514
Basic Memory uses [Loguru](https://github.com/Delgan/loguru) for logging. The logging behavior varies by entry point:
@@ -506,6 +531,7 @@ Basic Memory uses [Loguru](https://github.com/Delgan/loguru) for logging. The lo
506531
| `BASIC_MEMORY_FORCE_CLOUD` | `false` | When `true`, forces cloud API routing |
507532
| `BASIC_MEMORY_EXPLICIT_ROUTING` | `false` | When `true`, marks route selection as explicit (`--local`/`--cloud`) |
508533
| `BASIC_MEMORY_ENV` | `dev` | Set to `test` for test mode (stderr only) |
534+
| `BASIC_MEMORY_NO_PROMOS` | `false` | When `true`, disables cloud promo messages and telemetry |
509535

510536
### Examples
511537

0 commit comments

Comments
 (0)