Extend readme with basic example

Remove generated comments from commands

Author: Oleg Sucharevich

README.md

@@ -1 +1,23 @@
-# Codefresh SDK for Golang
+# Codefresh SDK for Golang
+
+# Start
+
+`go get -u github.com/codefresh-io`
+
+```go
+
+import (
+    "fmt"
+    "os"
+
+    "github.com/codefresh-io/go-sdk/pkg/util"
+    "github.com/codefresh-io/go-sdk/pkg/codefresh"
+)
+
+func main() {
+    path := fmt.Sprintf("%s/.cfconfig", os.Getenv("HOME"))
+    authOptions := util.ReadAuthContext(path, "")
+    cf := codefresh.New(authOptions)
+    cf.GetPipelines()
+}
+```

cmd/create.go

@@ -1,4 +1,4 @@
-// Copyright © 2018 NAME HERE <EMAIL ADDRESS>
+// Copyright © 2018 Codefresh.Inc
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -15,36 +15,13 @@
 package cmd
 
 import (
-	"fmt"
-
 	"github.com/spf13/cobra"
 )
 
-// createCmd represents the create command
 var createCmd = &cobra.Command{
-	Use:   "create",
-	Short: "A brief description of your command",
-	Long: `A longer description that spans multiple lines and likely contains examples
-and usage of using your command. For example:
-
-Cobra is a CLI library for Go that empowers applications.
-This application is a tool to generate the needed files
-to quickly create a Cobra application.`,
-	Run: func(cmd *cobra.Command, args []string) {
-		fmt.Println("create called")
-	},
+	Use: "create",
 }
 
 func init() {
 	rootCmd.AddCommand(createCmd)
-
-	// Here you will define your flags and configuration settings.
-
-	// Cobra supports Persistent Flags which will work for this command
-	// and all subcommands, e.g.:
-	// createCmd.PersistentFlags().String("foo", "", "A help for foo")
-
-	// Cobra supports local flags which will only run when this command
-	// is called directly, e.g.:
-	// createCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
 }

cmd/create_token.go

@@ -1,4 +1,4 @@
-// Copyright © 2018 NAME HERE <EMAIL ADDRESS>
+// Copyright © 2018 Codefresh.Inc
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -16,25 +16,18 @@ package cmd
 
 import (
 	"github.com/codefresh-io/go-sdk/internal"
-	"github.com/codefresh-io/go-sdk/pkg/codefresh"
+	"github.com/codefresh-io/go-sdk/pkg/utils"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 )
 
-// createTokenCmd represents the createToken command
 var createTokenCmd = &cobra.Command{
 	Use:     "tokens",
 	Aliases: []string{"token"},
 	Short:   "Create tokens",
-	Long: `A longer description that spans multiple lines and likely contains examples
-and usage of using your command. For example:
-
-Cobra is a CLI library for Go that empowers applications.
-This application is a tool to generate the needed files
-to quickly create a Cobra application.`,
 	Run: func(cmd *cobra.Command, args []string) {
 		client := viper.Get("codefresh")
-		codefreshClient := client.(codefresh.Codefresh)
+		codefreshClient := utils.CastToCodefreshOrDie(client)
 		token := codefreshClient.GenerateToken("TestToken", "hybrid/codefresh-re")
 		table := internal.CreateTable()
 		table.SetHeader([]string{"name", "token"})
@@ -45,14 +38,4 @@ to quickly create a Cobra application.`,
 
 func init() {
 	createCmd.AddCommand(createTokenCmd)
-
-	// Here you will define your flags and configuration settings.
-
-	// Cobra supports Persistent Flags which will work for this command
-	// and all subcommands, e.g.:
-	// createTokenCmd.PersistentFlags().String("foo", "", "A help for foo")
-
-	// Cobra supports local flags which will only run when this command
-	// is called directly, e.g.:
-	// createTokenCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
 }

cmd/get.go

@@ -1,4 +1,4 @@
-// Copyright © 2018 NAME HERE <EMAIL ADDRESS>
+// Copyright © 2018 Codefresh.Inc
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -15,35 +15,13 @@
 package cmd
 
 import (
-	"fmt"
-
 	"github.com/spf13/cobra"
 )
 
-// getCmd represents the get command
 var getCmd = &cobra.Command{
-	Use:   "get",
-	Short: "A brief description of your command",
-	Long: `A longer description that spans multiple lines and likely contains examples
-and usage of using your command. For example:
-
-Cobra is a CLI library for Go that empowers applications.
-This application is a tool to generate the needed files
-to quickly create a Cobra application.`,
-	Run: func(cmd *cobra.Command, args []string) {
-		fmt.Println("get called")
-	},
+	Use: "get",
 }
 
 func init() {
 	rootCmd.AddCommand(getCmd)
-	// Here you will define your flags and configuration settings.
-
-	// Cobra supports Persistent Flags which will work for this command
-	// and all subcommands, e.g.:
-	// getCmd.PersistentFlags().String("foo", "", "A help for foo")
-
-	// Cobra supports local flags which will only run when this command
-	// is called directly, e.g.:
-	// getCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
 }

cmd/get_pipeline.go

@@ -1,4 +1,4 @@
-// Copyright © 2018 NAME HERE <EMAIL ADDRESS>
+// Copyright © 2018 Codefresh.Inc
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -28,12 +28,6 @@ import (
 var getPipelineCmd = &cobra.Command{
 	Use:   "pipeline",
 	Short: "Get pipelines",
-	Long: `A longer description that spans multiple lines and likely contains examples
-and usage of using your command. For example:
-
-Cobra is a CLI library for Go that empowers applications.
-This application is a tool to generate the needed files
-to quickly create a Cobra application.`,
 	Run: func(cmd *cobra.Command, args []string) {
 		client := viper.Get("codefresh")
 		codefreshClient, ok := client.(codefresh.Codefresh)

cmd/get_tokens.go

@@ -1,4 +1,4 @@
-// Copyright © 2018 NAME HERE <EMAIL ADDRESS>
+// Copyright © 2018 Codefresh.Inc
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -18,29 +18,19 @@ import (
 	"fmt"
 
 	"github.com/codefresh-io/go-sdk/internal"
-	"github.com/codefresh-io/go-sdk/pkg/codefresh"
+	"github.com/codefresh-io/go-sdk/pkg/utils"
 	humanize "github.com/dustin/go-humanize"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
 )
 
-// getTokensCmd represents the getTokens command
 var getTokensCmd = &cobra.Command{
 	Use:     "tokens",
 	Aliases: []string{"token"},
-	Short:   "A brief description of your command",
-	Long: `A longer description that spans multiple lines and likely contains examples
-and usage of using your command. For example:
-
-Cobra is a CLI library for Go that empowers applications.
-This application is a tool to generate the needed files
-to quickly create a Cobra application.`,
+	Short:   "Get tokens",
 	Run: func(cmd *cobra.Command, args []string) {
 		client := viper.Get("codefresh")
-		codefreshClient, ok := client.(codefresh.Codefresh)
-		if !ok {
-			panic("Faild to create Codefresh cleint")
-		}
+		codefreshClient := utils.CastToCodefreshOrDie(client)
 		table := internal.CreateTable()
 		table.SetHeader([]string{"Created", "ID", "Name", "Reference Subject", "Reference Type", "Token"})
 		table.Append([]string{"", "", ""})
@@ -61,14 +51,4 @@ to quickly create a Cobra application.`,
 
 func init() {
 	getCmd.AddCommand(getTokensCmd)
-
-	// Here you will define your flags and configuration settings.
-
-	// Cobra supports Persistent Flags which will work for this command
-	// and all subcommands, e.g.:
-	// getTokensCmd.PersistentFlags().String("foo", "", "A help for foo")
-
-	// Cobra supports local flags which will only run when this command
-	// is called directly, e.g.:
-	// getTokensCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
 }

cmd/root.go

@@ -1,4 +1,4 @@
-// Copyright © 2018 NAME HERE <EMAIL ADDRESS>
+// Copyright © 2018 Codefresh.Inc
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -27,20 +27,10 @@ import (
 
 var cfgFile string
 
-// rootCmd represents the base command when called without any subcommands
 var rootCmd = &cobra.Command{
 	Use:   "cfctl",
 	Short: "A command line application for Codefresh",
-	Long: `A longer description that spans multiple lines and likely contains
-examples and usage of using your application. For example:
-
-Cobra is a CLI library for Go that empowers applications.
-This application is a tool to generate the needed files
-to quickly create a Cobra application.`,
-	// Uncomment the following line if your bare application
-	// has an action associated with it:
-	// Run: func(cmd *cobra.Command, args []string) {
-	// },
+	Long:  ``,
 
 	PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
 		configPath := cmd.Flag("cfconfig").Value.String()
@@ -65,8 +55,6 @@ to quickly create a Cobra application.`,
 	},
 }
 
-// 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.
 func Execute() {
 	if err := rootCmd.Execute(); err != nil {
 		fmt.Println(err)

pkg/utils/utils.go

@@ -0,0 +1,13 @@
+package utils
+
+import (
+	"github.com/codefresh-io/go-sdk/pkg/codefresh"
+)
+
+func CastToCodefreshOrDie(candidate interface{}) codefresh.Codefresh {
+	client, ok := candidate.(codefresh.Codefresh)
+	if !ok {
+		panic("Failed to cast candidate to Codefresh client")
+	}
+	return client
+}