diff --git a/apps/docs/content/guides/local-development/cli/getting-started.mdx b/apps/docs/content/guides/local-development/cli/getting-started.mdx index 4d9ab20346c..662cd323f46 100644 --- a/apps/docs/content/guides/local-development/cli/getting-started.mdx +++ b/apps/docs/content/guides/local-development/cli/getting-started.mdx @@ -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) diff --git a/apps/docs/content/guides/self-hosting.mdx b/apps/docs/content/guides/self-hosting.mdx index 6802d6b3dfe..2a4e94bfb1d 100644 --- a/apps/docs/content/guides/self-hosting.mdx +++ b/apps/docs/content/guides/self-hosting.mdx @@ -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 diff --git a/apps/docs/spec/cli_v1_commands.yaml b/apps/docs/spec/cli_v1_commands.yaml index c5785d08f3a..d7c1c5ca876 100644 --- a/apps/docs/spec/cli_v1_commands.yaml +++ b/apps/docs/spec/cli_v1_commands.yaml @@ -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 diff --git a/apps/docs/spec/common-cli-sections.json b/apps/docs/spec/common-cli-sections.json index ebec574b2cb..ce84665e57b 100644 --- a/apps/docs/spec/common-cli-sections.json +++ b/apps/docs/spec/common-cli-sections.json @@ -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" + } + ] } ]