Add usage documentation

Author: chand1012

Justfile

@@ -9,3 +9,6 @@ clean:
 
 run *commands:
   go run main.go {{commands}}
+
+cobra-docs:
+  go run docs/gen_docs.go

cmd/chat.go

@@ -55,7 +55,7 @@ If '-q' is not specified, the user will be prompted to enter a question.
 }
 
 func init() {
-	rootCmd.AddCommand(chatCmd)
+	RootCmd.AddCommand(chatCmd)
 
 	chatCmd.Flags().StringVarP(&question, "question", "q", "", "Question to chat ChatGPT")
 }

cmd/doc.go

@@ -79,7 +79,7 @@ var docCmd = &cobra.Command{
 }
 
 func init() {
-	rootCmd.AddCommand(docCmd)
+	RootCmd.AddCommand(docCmd)
 
 	// see cmd/vars.go for the definition of these flags
 	docCmd.Flags().StringVarP(&filePath, "file", "f", "", "The file to document")

cmd/docs.go

@@ -135,7 +135,7 @@ search for files in the directory and document them.
 }
 
 func init() {
-	rootCmd.AddCommand(docsCmd)
+	RootCmd.AddCommand(docsCmd)
 
 	// see cmd/vars for the definition of these flags
 	docsCmd.Flags().StringVarP(&chatPrompt, "prompt", "p", "", "Prompt to use for the ChatGPT API")

cmd/login.go

@@ -42,7 +42,7 @@ This API key will be used to authenticate with the OpenAI ChatGPT API.`,
 }
 
 func init() {
-	rootCmd.AddCommand(loginCmd)
+	RootCmd.AddCommand(loginCmd)
 
 	loginCmd.Flags().StringVarP(&apiKey, "apikey", "k", "", "API key to add to configuration")
 }

cmd/prompt.go

@@ -78,7 +78,7 @@ var promptCmd = &cobra.Command{
 }
 
 func init() {
-	rootCmd.AddCommand(promptCmd)
+	RootCmd.AddCommand(promptCmd)
 
 	// see cmd/vars.go for the definition of these flags
 	promptCmd.Flags().StringVarP(&preambleFile, "preamble", "p", "", "path to preamble text file")

cmd/root.go

@@ -9,8 +9,8 @@ import (
 	"github.com/spf13/cobra"
 )
 
-// rootCmd represents the base command when called without any subcommands
-var rootCmd = &cobra.Command{
+// RootCmd represents the base command when called without any subcommands
+var RootCmd = &cobra.Command{
 	Use:   "otto",
 	Short: "Document your code with ease",
 	Long:  `Code documentation made easy using GPT.`,
@@ -20,9 +20,9 @@ var rootCmd = &cobra.Command{
 }
 
 // Execute adds all child commands to the root command and sets flags appropriately.
-// This is called by main.main(). It only needs to happen once to the rootCmd.
+// This is called by main.main(). It only needs to happen once to the RootCmd.
 func Execute() {
-	err := rootCmd.Execute()
+	err := RootCmd.Execute()
 	if err != nil {
 		os.Exit(1)
 	}
@@ -33,9 +33,9 @@ func init() {
 	// Cobra supports persistent flags, which, if defined here,
 	// will be global for your application.
 
-	// rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.ottodocs.yaml)")
+	// RootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.ottodocs.yaml)")
 
 	// Cobra also supports local flags, which will only run
 	// when this action is called directly.
-	// rootCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
+	// RootCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
 }

docs/gen_docs.go

@@ -0,0 +1,13 @@
+package main
+
+import (
+	"github.com/chand1012/ottodocs/cmd"
+	"github.com/spf13/cobra/doc"
+)
+
+func main() {
+	err := doc.GenMarkdownTree(cmd.RootCmd, "./docs")
+	if err != nil {
+		panic(err)
+	}
+}

docs/otto.md

@@ -0,0 +1,23 @@
+## otto
+
+Document your code with ease
+
+### Synopsis
+
+Code documentation made easy using GPT.
+
+### Options
+
+```
+  -h, --help   help for otto
+```
+
+### SEE ALSO
+
+* [otto chat](otto_chat.md)	 - Ask ChatGPT a question from the command line.
+* [otto doc](otto_doc.md)	 - Document a file
+* [otto docs](otto_docs.md)	 - Document a repository of files
+* [otto login](otto_login.md)	 - Add an API key to your configuration
+* [otto prompt](otto_prompt.md)	 - Generates a ChatGPT prompt from a given Git repo
+
+###### Auto generated by spf13/cobra on 18-Mar-2023

docs/otto_chat.md

@@ -0,0 +1,27 @@
+## otto chat
+
+Ask ChatGPT a question from the command line.
+
+### Synopsis
+
+Ask ChatGPT a question from the command line.
+
+If '-q' is not specified, the user will be prompted to enter a question.
+	
+
+```
+otto chat [flags]
+```
+
+### Options
+
+```
+  -h, --help              help for chat
+  -q, --question string   Question to chat ChatGPT
+```
+
+### SEE ALSO
+
+* [otto](otto.md)	 - Document your code with ease
+
+###### Auto generated by spf13/cobra on 18-Mar-2023