Skip to content

Commit bbb0497

Browse files
authored
Merge pull request #154 from syncable-dev/develop
update: added privacy-policy for telemetry
2 parents c23e3be + 60af973 commit bbb0497

2 files changed

Lines changed: 42 additions & 274 deletions

File tree

CONTRIBUTING.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,48 @@ Thank you for your interest in contributing to the Syncable Infrastructure-as-Co
66

77
We are committed to providing a welcoming and inclusive environment. Please be respectful and constructive in all interactions.
88

9+
## 🛡️ Telemetry and Privacy
10+
11+
Syncable CLI collects anonymous usage data to help us improve the product. This data includes:
12+
13+
- Command usage (which commands are run)
14+
- System information (OS type, CLI version)
15+
- Performance metrics (execution time, success/failure status)
16+
17+
We do NOT collect:
18+
- Personal or sensitive information
19+
- File contents or project data
20+
- Environment variables or secrets
21+
- Any personally identifiable information
22+
23+
### Opting Out of Telemetry
24+
25+
Users can opt out of telemetry collection through multiple methods:
26+
27+
1. **Command-Line Flag**: Add `--disable-telemetry` to any command
28+
```bash
29+
sync-ctl --disable-telemetry analyze .
30+
```
31+
32+
2. **Environment Variable**: Set `SYNCABLE_CLI_TELEMETRY=false`
33+
```bash
34+
export SYNCABLE_CLI_TELEMETRY=false
35+
sync-ctl analyze .
36+
```
37+
38+
3. **Configuration File**: Add the following to your `.syncable.toml` file
39+
```toml
40+
[telemetry]
41+
enabled = false
42+
```
43+
44+
The opt-out mechanisms follow this priority order:
45+
1. `--disable-telemetry` CLI flag (highest priority)
46+
2. `SYNCABLE_CLI_TELEMETRY` environment variable (medium priority)
47+
3. `telemetry.enabled` in config file (lowest priority)
48+
49+
Our telemetry system is designed with user privacy in mind. All data is anonymized and collected in compliance with privacy regulations.
50+
951
## 🚀 Getting Started
1052

1153
### Prerequisites

docs/BUN_INTEGRATION.md

Lines changed: 0 additions & 274 deletions
This file was deleted.

0 commit comments

Comments
 (0)