From dae694bafa378baee6b526c9c108114575d644cc Mon Sep 17 00:00:00 2001 From: evelynmitchell Date: Wed, 10 Jul 2024 18:42:57 -0600 Subject: [PATCH] Update install.md with env var docs #521 requested docs on turning off telemetry. --- docs/swarms/install/install.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/swarms/install/install.md b/docs/swarms/install/install.md index 978466a4..46d2c57e 100644 --- a/docs/swarms/install/install.md +++ b/docs/swarms/install/install.md @@ -76,6 +76,17 @@ You can install `swarms` with pip in a npm install swarms-js ``` +## Environment Variables + +Environment variables are used in Swarms for holding API Keys and other system configuration. See .env.example for others. + +The initial ones to set are: + +``` +OPENAI_API_KEY="sk-..." # your OpenAI key +USE_TELEMETRY="True" # or "False" if you would like to disable telemetry +``` + ## Documentation