Skip to content

Commit 13ea9bd

Browse files
phernandezclaude
andcommitted
docs: add telemetry section to README
Documents the anonymous telemetry feature including: - What data is collected and what is never collected - How to opt out via CLI or environment variable - Link to detailed documentation 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <[email protected]> Signed-off-by: phernandez <[email protected]>
1 parent a2b735e commit 13ea9bd

File tree

2 files changed

+35
-2
lines changed

2 files changed

+35
-2
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -466,6 +466,39 @@ tail -f ~/.basic-memory/basic-memory.log
466466
BASIC_MEMORY_CLOUD_MODE=true uvicorn basic_memory.api.app:app
467467
```
468468

469+
## Telemetry
470+
471+
Basic Memory collects anonymous usage statistics to help improve the software. This follows the [Homebrew model](https://docs.brew.sh/Analytics) - telemetry is on by default with easy opt-out.
472+
473+
**What we collect:**
474+
- App version, Python version, OS, architecture
475+
- Feature usage (which MCP tools and CLI commands are used)
476+
- Error types (sanitized - no file paths or personal data)
477+
478+
**What we NEVER collect:**
479+
- Note content, file names, or paths
480+
- Personal information
481+
- IP addresses
482+
483+
**Opting out:**
484+
```bash
485+
# Disable telemetry
486+
basic-memory telemetry disable
487+
488+
# Check status
489+
basic-memory telemetry status
490+
491+
# Re-enable
492+
basic-memory telemetry enable
493+
```
494+
495+
Or set the environment variable:
496+
```bash
497+
export BASIC_MEMORY_TELEMETRY_ENABLED=false
498+
```
499+
500+
For more details, see the [Telemetry documentation](https://basicmemory.com/telemetry).
501+
469502
## Development
470503

471504
### Running Tests

src/basic_memory/telemetry.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
- Personal information
1717
- IP addresses (OpenPanel doesn't store these)
1818
19-
Documentation: https://memory.basicmachines.co/telemetry
19+
Documentation: https://basicmemory.com/telemetry
2020
"""
2121

2222
import platform
@@ -37,7 +37,7 @@
3737
OPENPANEL_CLIENT_ID = "2e7b036d-c6e5-40aa-91eb-5c70a8ef21a3"
3838
OPENPANEL_CLIENT_SECRET = "sec_92f7f8328bd0368ff4c2"
3939

40-
TELEMETRY_DOCS_URL = "https://memory.basicmachines.co/telemetry"
40+
TELEMETRY_DOCS_URL = "https://basicmemory.com/telemetry"
4141

4242
TELEMETRY_NOTICE = f"""
4343
Basic Memory collects anonymous usage statistics to help improve the software.

0 commit comments

Comments
 (0)