Skip to content

Commit b9857be

Browse files
committed
Update Telemetry doc
Update TELEMETRY.md doc with information on what's being collected and how to disable it.
1 parent 14931c7 commit b9857be

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

docs/TELEMETRY.md

+9-6
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,13 @@ The telemetry data we collect includes:
1111
- **Development Steps**: The number of development steps that were performed.
1212
- **LLM Requests**: The number of LLM requests made.
1313
- **User Inputs**: The number of times you provide input to the tool.
14+
- **Operating System**: The operating system you are using (and Linux distro if applicable).
15+
- **Python Version**: The version of Python you are using.
16+
- **GPT Pilot Version**: The version of GPT Pilot you are using.
17+
- **LLM Model**: LLM model used for the session.
18+
- **Time**: How long it took to generate a project.
19+
20+
All the data points are listed in [pilot.utils.telemetry:Telemetry.clear_data()](../pilot/utils/telemetry.py).
1421

1522
### How We Use This Data
1623

@@ -27,13 +34,9 @@ Your privacy is important to us. The data collected is purely for internal analy
2734

2835
### Opting Out
2936

30-
We believe in transparency and control. If you prefer not to send telemetry data, you can opt-out at any time by running the following command:
31-
32-
```bash
33-
gpt-pilot telemetry disable
34-
```
37+
We believe in transparency and control. If you prefer not to send telemetry data, you can opt-out at any time by setting `telemetry.enabled` to `false` in your `~/.gpt-pilot/config.json` configuration file.
3538

36-
After you run this command, GPT Pilot will no longer collect telemetry data from your machine.
39+
After you update this setting, GPT Pilot will no longer collect telemetry data from your machine.
3740

3841
### Questions and Feedback
3942
If you have questions about our telemetry practices or would like to provide feedback, please open an issue in our repository, and we will be happy to engage with you.

0 commit comments

Comments
 (0)