fix: Use a more descriptive OpenAI API_KEY env (#17)

dkoshkin · Apr 1, 2023 · 9255a5e · 9255a5e
1 parent 50e8dc5
commit 9255a5e
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -20,11 +20,12 @@ It aims to help find `kubectl` commands for what you are trying to accomplish, w
 
 2.  Move it somewhere in your `PATH`.
 
-3.  Generate an API Key [here](https://platform.openai.com/account/api-keys).
+3.  Generate an OpenAI API Key [here](https://platform.openai.com/account/api-keys).
 
 4.  Run `kubectl assistant`
 
     ```txt
+    $ export OPENAI_API_KEY=<>
     $ kubectl assistant
     Begin by typing what you want to accomplish in your Kubernetes cluster and then hit "Enter".
     For example:

diff --git a/main.go b/main.go
@@ -17,7 +17,8 @@ import (
 )
 
 const (
-	apiKeyEnv = "API_KEY"
+	//nolint:gosec // Not a hardcoded credentials
+	apiKeyEnv = "OPENAI_API_KEY"
 )
 
 func main() {