Skip to content

Commit

Permalink
Document environment variables for api key (#47)
Browse files Browse the repository at this point in the history
Thank you @samgabrail for the feedback
  • Loading branch information
aantn authored Jun 19, 2024
1 parent 2d05f29 commit a43a938
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,14 @@ To work with OpenAI’s GPT 3.5 or GPT-4 models you need a paid [OpenAI API key]

**Note**: This is different from being a “ChatGPT Plus” subscriber.

Add the `api_key` to the config.yaml or pass via the CLI with --api-key.
Pass your API key to holmes with the `--api-key` cli argument:

```
holmes ask --api-key="..." "what pods are crashing in my cluster and why?"
```

Alternatively, you can set the OPENAI_API_KEY environment variable or save the API key in a HolmesGPT config file.

</details>

<details>
Expand All @@ -193,6 +200,9 @@ To work with Azure AI, you need the [Azure OpenAI](https://learn.microsoft.com/e
holmes ask "what pods are unhealthy and why?" --llm=azure --api-key=<PLACEHOLDER> --azure-endpoint='<PLACEHOLDER>'
```

Alternatively, you can set the AZURE_OPENAI_API_KEY environment variable or save the API key in a HolmesGPT config file.


</details>

<details>
Expand Down

0 comments on commit a43a938

Please sign in to comment.