cmd telemetry - nself-org/cli GitHub Wiki
Manage CLI telemetry opt-in/out preferences.
nself telemetry <subcommand> [flags]
| Subcommand | Description |
|---|---|
status |
Show the current telemetry opt-out state |
off |
Opt out of telemetry (writes to ~/.nself/config.toml) |
on |
Opt in to telemetry (writes to ~/.nself/config.toml) |
nself telemetry manages your preference for CLI usage telemetry.
v1.1.1 ships the opt-in telemetry client. Collection is OFF by default; you must explicitly opt in. The client collects only anonymous aggregate data (CLI version, platform, architecture, command counts) for usage analysis. All collection respects your stored preference.
See Privacy Policy for full details.
-
NSELF_TELEMETRY_OPT_OUT=1environment variable (highest priority) -
~/.nself/config.toml[telemetry]section - Default: disabled (opt-in)
The environment variable always wins. Use it for CI/CD pipelines or shared servers where you do not want to modify the config file.
# Check current status
nself telemetry status
# Opt out permanently (writes to ~/.nself/config.toml)
nself telemetry off
# Opt back in
nself telemetry on
# Opt out via environment variable (no file change)
NSELF_TELEMETRY_OPT_OUT=1 nself telemetry statusSample output (status):
Telemetry: disabled (default)
Source: default
v1.1.1: opt-in telemetry client. Run 'nself telemetry on' to enable.
Privacy policy: https://nself.org/legal/privacy
After running nself telemetry on:
Telemetry: enabled (opt-in)
Source: config
v1.1.1: opt-in telemetry client active. Anonymous aggregate data only.
Privacy policy: https://nself.org/legal/privacy
Preferences are stored in ~/.nself/config.toml:
[telemetry]
enabled = falseThis file is shared with other ɳSelf user-level settings. It is created automatically when you run nself telemetry off or nself telemetry on.
All security features in ɳSelf are free. When telemetry ships in v1.1.0, it will be:
- Opt-in only
- Anonymous (no personal data, no project names, no IP addresses stored)
- Transparent (exact fields documented in the Privacy Policy before collection begins)