Skip to content

Commit

Permalink
[C3] telemetry docs (#16718)
Browse files Browse the repository at this point in the history
Co-authored-by: Jun Lee <junlee@cloudflare.com>
  • Loading branch information
edmundhung and Oxyjun authored Sep 27, 2024
1 parent 0241913 commit df1bdcc
Showing 1 changed file with 35 additions and 1 deletion.
36 changes: 35 additions & 1 deletion src/content/docs/pages/get-started/c3.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: Use C3 (`create-cloudflare` CLI) to set up and deploy new
deployment.
---

import { Render, TabItem, Tabs, Type, MetaInfo } from "~/components";
import { Render, TabItem, Tabs, Type, MetaInfo, PackageManagers } from "~/components";

Cloudflare provides a CLI command for creating new Workers and Pages projects — `npm create cloudflare`, powered by the [`create-cloudflare` package](https://www.npmjs.com/package/create-cloudflare).

Expand Down Expand Up @@ -221,3 +221,37 @@ bun create cloudflare@latest [--] [<DIRECTORY>] [OPTIONS] [-- <NESTED ARGS...>]
All the boolean options above can be specified with or without a value, for example `--open` and `--open true` have the same effect, prefixing `no-` to the option's name negates it, so for example `--no-open` and `--open false` have the same effect.

:::

## Telemetry

Cloudflare collects anonymous usage data to improve `create-cloudflare` over time. Read more about this in our [data policy](https://github.com/cloudflare/workers-sdk/blob/main/packages/create-cloudflare/telemetry.md).

You can opt-out if you do not wish to share any information.

<PackageManagers
type="create"
pkg="cloudflare@latest"
args="telemetry disable"
/>

Alternatively, you can set an environment variable:

```sh
export CREATE_CLOUDFLARE_TELEMETRY_DISABLED=1
```

You can check the status of telemetry collection at any time.

<PackageManagers
type="create"
pkg="cloudflare@latest"
args="telemetry status"
/>

You can always re-enable telemetry collection.

<PackageManagers
type="create"
pkg="cloudflare@latest"
args="telemetry enable"
/>

0 comments on commit df1bdcc

Please sign in to comment.