@clef-sh/analytics 0.1.17 → 0.1.18-beta.92
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +43 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# @clef-sh/analytics
|
|
2
|
+
|
|
3
|
+
Anonymous CLI analytics for [Clef](https://clef.sh). Collects command usage telemetry to help improve the tool. Powered by PostHog. Fully opt-out.
|
|
4
|
+
|
|
5
|
+
No secret values, file contents, key names, or repository paths are ever collected.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install @clef-sh/analytics
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## What is collected
|
|
14
|
+
|
|
15
|
+
- Command name and duration
|
|
16
|
+
- CLI version
|
|
17
|
+
- OS platform and architecture
|
|
18
|
+
- Success/failure status
|
|
19
|
+
|
|
20
|
+
## What is never collected
|
|
21
|
+
|
|
22
|
+
- Secret values or key names
|
|
23
|
+
- File contents or paths
|
|
24
|
+
- Repository URLs or identifiers
|
|
25
|
+
- Environment names or namespace names
|
|
26
|
+
|
|
27
|
+
## Opt out
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
# Session
|
|
31
|
+
export CLEF_ANALYTICS=0
|
|
32
|
+
|
|
33
|
+
# Permanent
|
|
34
|
+
clef config set analytics false
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Documentation
|
|
38
|
+
|
|
39
|
+
- [Privacy & telemetry](https://docs.clef.sh/guide/telemetry)
|
|
40
|
+
|
|
41
|
+
## License
|
|
42
|
+
|
|
43
|
+
MIT
|