Compare commits

..

3 Commits

Author SHA1 Message Date
Alex Jones
dc8535b70a fixing spelling on path
Signed-off-by: Alex Jones <alexsimonjones@gmail.com>
2023-03-28 12:12:24 +01:00
Alex Jones
02f5f921e2 Merge pull request #104 from k8sgpt-ai/chore/readme-update
feat: updated readme
2023-03-28 12:05:05 +01:00
Alex Jones
e0141d1cf5 feat: updated readme
Signed-off-by: Alex Jones <alexsimonjones@gmail.com>
2023-03-28 11:51:50 +01:00
2 changed files with 5 additions and 2 deletions

View File

@@ -14,6 +14,9 @@ brew tap k8sgpt-ai/k8sgpt
brew install k8sgpt
```
_brew also enables upgrades with `brew upgrade k8sgpt`_
* Currently the default AI provider is OpenAI, you will need to generate an API key from [OpenAI](https://openai.com)
* You can do this by running `k8sgpt generate` to open a browser link to generate it
* Run `k8sgpt auth` to set it in k8sgpt.
@@ -93,7 +96,7 @@ K8sgpt is focused on triaging and diagnosing issues in your cluster. It is a too
### Configuration
`k8sgpt` stores config data in `~/.k8sgpt` the data is stored in plain text, including your OpenAI key.
`k8sgpt` stores config data in `~/.k8sgpt.yaml` the data is stored in plain text, including your OpenAI key.
### Contributing

View File

@@ -48,7 +48,7 @@ func init() {
rootCmd.AddCommand(auth.AuthCmd)
rootCmd.AddCommand(analyze.AnalyzeCmd)
rootCmd.AddCommand(generate.GenerateCmd)
rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.k8sgpt.git.yaml)")
rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.k8sgpt.yaml)")
rootCmd.PersistentFlags().StringVar(&masterURL, "master", "", "The address of the Kubernetes API server. Overrides any value in kubeconfig. Only required if out-of-cluster.")
rootCmd.PersistentFlags().StringVar(&kubeconfig, "kubeconfig", "", "Path to a kubeconfig. Only required if out-of-cluster.")
// Cobra also supports local flags, which will only run