docs: CLI telemetry disclosure (#44662)

## Summary

The CLI now collects usage telemetry (supabase/cli#5019) with opt-out
via `supabase telemetry disable` or `SUPABASE_TELEMETRY_DISABLED=1`. The
self-hosting docs previously stated "no telemetry" without
distinguishing Docker from the CLI. This PR discloses CLI telemetry
across docs and regenerates the CLI reference spec to include the new
telemetry commands.

## Changes
- Update self-hosting telemetry section: Docker has no telemetry, CLI is
separate with opt-out instructions and link to full telemetry docs
- Regenerate `cli_v1_commands.yaml` from CLI v2.88.0, adding
consolidated `supabase telemetry` reference page
- Add Telemetry category to `common-cli-sections.json` for CLI reference
nav
- Add telemetry section to CLI getting-started guide with opt-out
commands and env vars

## Testing

Tested on Vercel preview:
- [x] `/docs/guides/self-hosting#telemetry` renders with CLI telemetry
note and link to full docs
- [x] `/docs/reference/cli/supabase-telemetry` renders single
consolidated reference page
- [x] `/docs/guides/local-development/cli/getting-started#telemetry`
shows opt-out section

## Linear
- fixes GROWTH-754
This commit is contained in:
Pamela Chia authored and GitHub committed 2026-04-08 22:06:56 +09:00
1 parent 0eb7911e95
commit 2536593594
4 files changed
+47 -2

No files matched your search

@@ -344,6 +344,27 @@ When you are finished working on your Supabase project, you can stop the stack (
supabase stop
```
## Telemetry
The Supabase CLI collects telemetry data about general usage. Participating in this program is optional, and you can opt out at any time.
### How to opt out
You can disable telemetry by running:
```bash
supabase telemetry disable
```
You can check the current status and re-enable with:
```bash
supabase telemetry status
supabase telemetry enable
```
You can also opt out using the `SUPABASE_TELEMETRY_DISABLED=1` environment variable. The broader `DO_NOT_TRACK=1` convention is also respected.
## Learn more
- [CLI configuration](/docs/guides/local-development/cli/config)
+3 -1
View File
@@ -66,7 +66,9 @@ Self-hosted Supabase is different from:
### Telemetry
Self-hosted Supabase does not phone home or collect any telemetry.
Self-hosted Supabase (Docker) does not phone home or collect any telemetry.
The **Supabase CLI** is a [separate tool](/docs/guides/local-development/cli/getting-started) from self-hosted Supabase and collects usage telemetry to help improve the developer experience. You can opt out by running `supabase telemetry disable` or setting `SUPABASE_TELEMETRY_DISABLED=1`. See [CLI telemetry](/docs/guides/local-development/cli/getting-started#telemetry) for other opt-out methods.
### Your responsibilities when self-hosting
+11 -1
View File
@@ -1,7 +1,7 @@
clispec: '001'
info:
id: cli
version: 2.84.2
version: 2.88.0
title: Supabase CLI
language: sh
source: https://github.com/supabase/cli
@@ -275,6 +275,16 @@ commands:
name: --local
description: Runs pgTAP tests on the local database.
default_value: 'true'
- id: supabase-telemetry
title: supabase telemetry
summary: Manage CLI telemetry settings
description: |
The Supabase CLI collects telemetry data about general usage. Participating in this program is optional. You can opt out by running `supabase telemetry disable` or setting `SUPABASE_TELEMETRY_DISABLED=1`. Use `supabase telemetry status` to check your current setting and `supabase telemetry enable` to opt back in.
tags:
- local-dev
links: []
subcommands: []
flags: []
- id: supabase-storage
title: supabase storage
summary: Manage Supabase Storage objects
+12
View File
@@ -884,5 +884,17 @@
"type": "cli-command"
}
]
},
{
"type": "category",
"title": "Telemetry",
"items": [
{
"id": "supabase-telemetry",
"title": "Manage CLI telemetry settings",
"slug": "supabase-telemetry",
"type": "cli-command"
}
]
}
]