update README

Author: Alvaro Muñoz

README.md

@@ -35,7 +35,7 @@ Available Commands:
   download    Downloads a CodeQL database from GitHub Code Scanning
   help        Help about any command
   install     Install a local CodeQL database in the QLDB directory
-  path        Returns the path to a database stored in the QLDB structure
+  info        Returns information about a database stored in the QLDB structure
 
 Flags:
   -h, --help   help for gh-qldb
@@ -64,7 +64,7 @@ gh qldb install -d path/to/database -n apache/logging-log4j2
 #### Get information about a database
 
 ```bash
-gh qldb path -n apache/logging-log4j2 -l java -j
+gh qldb info -n apache/logging-log4j2 -l java -j
 [
   {
     "commitSha": "fa2f51e",

cmd/info.go

@@ -1,62 +1,62 @@
 package cmd
 
 import (
-  "github.com/GitHubSecurityLab/gh-qldb/utils"
-  "github.com/spf13/cobra"
-  "path/filepath"
-  "log"
-  "fmt"
-  "io/ioutil"
-  "encoding/json"
+	"encoding/json"
+	"fmt"
+	"github.com/GitHubSecurityLab/gh-qldb/utils"
+	"github.com/spf13/cobra"
+	"io/ioutil"
+	"log"
+	"path/filepath"
 )
+
 var infoCmd = &cobra.Command{
-    Use:   "info",
-    Short: "Returns information for a database stored in the QLDB structure",
-    Long:  `Returns information for a database stored in the QLDB structure`,
-    Run: func(cmd *cobra.Command, args []string) {
-      info(nwoFlag, languageFlag)
-    },
-  }
+	Use:   "info",
+	Short: "Returns information about a database stored in the QLDB structure",
+	Long:  `Returns information about a database stored in the QLDB structure`,
+	Run: func(cmd *cobra.Command, args []string) {
+		info(nwoFlag, languageFlag)
+	},
+}
 
 func init() {
-  rootCmd.AddCommand(infoCmd)
-  infoCmd.Flags().StringVarP(&nwoFlag, "nwo", "n", "", "The NWO of the repository to get the database for.")
-  infoCmd.Flags().StringVarP(&languageFlag, "language", "l", "", "The primary language you want the database for.")
-  infoCmd.Flags().BoolVarP(&jsonFlag, "json", "j", false, "Use json as the output format.")
-  infoCmd.MarkFlagRequired("nwo")
-  infoCmd.MarkFlagRequired("language")
+	rootCmd.AddCommand(infoCmd)
+	infoCmd.Flags().StringVarP(&nwoFlag, "nwo", "n", "", "The NWO of the repository to get the database for.")
+	infoCmd.Flags().StringVarP(&languageFlag, "language", "l", "", "The primary language you want the database for.")
+	infoCmd.Flags().BoolVarP(&jsonFlag, "json", "j", false, "Use json as the output format.")
+	infoCmd.MarkFlagRequired("nwo")
+	infoCmd.MarkFlagRequired("language")
 }
 
 func info(nwo string, language string) {
-  dir := filepath.Join(utils.GetPath(nwo), language)
-  files, err := ioutil.ReadDir(dir)
-  if err != nil {
-    log.Fatal(err)
-  }
-  var pathList []map[string]string
-  for _, f := range files {
-    filename := f.Name()
-    sha := filename[:len(filename)-len(filepath.Ext(filename))]
-    commitSha, committedDate, err := utils.GetCommitInfo(nwo, sha)
-    if err != nil {
-      log.Fatal(err)
-    }
-    pathList = append(pathList, map[string]string{
-      "commitSha": commitSha,
-      "committedDate": committedDate,
-      "path": filepath.Join(dir, filename),
-    })
-  }
-    if jsonFlag {
-      jsonStr, err := json.MarshalIndent(pathList, "", "  ")
-      if err != nil {
-        log.Fatal(err)
-      }
-      fmt.Printf("%s", jsonStr)
-    } else {
-      for _, path := range pathList {
-        fmt.Printf("%s (%s)", path["path"], path["committedDate"])
-      }
-    }
+	dir := filepath.Join(utils.GetPath(nwo), language)
+	files, err := ioutil.ReadDir(dir)
+	if err != nil {
+		log.Fatal(err)
+	}
+	var pathList []map[string]string
+	for _, f := range files {
+		filename := f.Name()
+		sha := filename[:len(filename)-len(filepath.Ext(filename))]
+		commitSha, committedDate, err := utils.GetCommitInfo(nwo, sha)
+		if err != nil {
+			log.Fatal(err)
+		}
+		pathList = append(pathList, map[string]string{
+			"commitSha":     commitSha,
+			"committedDate": committedDate,
+			"path":          filepath.Join(dir, filename),
+		})
+	}
+	if jsonFlag {
+		jsonStr, err := json.MarshalIndent(pathList, "", "  ")
+		if err != nil {
+			log.Fatal(err)
+		}
+		fmt.Printf("%s", jsonStr)
+	} else {
+		for _, path := range pathList {
+			fmt.Printf("%s (%s)", path["path"], path["committedDate"])
+		}
+	}
 }
-