Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update install.md with env var docs #530

Closed
wants to merge 1 commit into from
Closed

Update install.md with env var docs #530

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Update install.md with env var docs 
#521 requested docs on turning off telemetry.
  • Loading branch information
@evelynmitchell
evelynmitchell authored Jul 11, 2024
commit dae694bafa378baee6b526c9c108114575d644cc
11 changes: 11 additions & 0 deletions docs/swarms/install/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading