init structure

Author: Ish Shah

cmd/operator-sdk/main.go

@@ -44,6 +44,20 @@ import (
 )
 
 func main() {
+	root := GetCLIRoot()
+
+	root.PersistentFlags().Bool(flags.VerboseOpt, false, "Enable verbose logging")
+	if err := viper.BindPFlags(root.PersistentFlags()); err != nil {
+		log.Fatalf("Failed to bind root flags: %v", err)
+	}
+
+	if err := root.Execute(); err != nil {
+		os.Exit(1)
+	}
+}
+
+// GetCLIRoot is intended to creeate the base command structure for the OSDK for use in CLI and documentation
+func GetCLIRoot() *cobra.Command {
 	root := &cobra.Command{
 		Use:   "operator-sdk",
 		Short: "An SDK for building operators with ease",
@@ -76,14 +90,7 @@ func main() {
 	root.AddCommand(up.NewCmd())
 	root.AddCommand(version.NewCmd())
 
-	root.PersistentFlags().Bool(flags.VerboseOpt, false, "Enable verbose logging")
-	if err := viper.BindPFlags(root.PersistentFlags()); err != nil {
-		log.Fatalf("Failed to bind root flags: %v", err)
-	}
-
-	if err := root.Execute(); err != nil {
-		os.Exit(1)
-	}
+	return root
 }
 
 func checkGoModulesForCmd(cmd *cobra.Command) (err error) {

go.mod

@@ -24,6 +24,7 @@ require (
 	github.com/exponent-io/jsonpath v0.0.0-20151013193312-d6023ce2651d // indirect
 	github.com/fatih/camelcase v1.0.0 // indirect
 	github.com/ghodss/yaml v1.0.0
+	github.com/go-logfmt/logfmt v0.4.0 // indirect
 	github.com/go-logr/logr v0.1.0
 	github.com/go-logr/zapr v0.1.1
 	github.com/go-openapi/swag v0.19.0 // indirect

hack/doc/gen-cli-doc.go

@@ -0,0 +1,32 @@
+// Copyright 2019 The Operator-SDK Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package main
+
+import (
+	cmd "github.com/operator-framework/operator-sdk/cmd/operator-sdk"
+
+	"github.com/spf13/cobra/doc"
+
+	log "github.com/sirupsen/logrus"
+)
+
+func main() {
+	root := cmd.GetCLIRoot()
+
+	err := doc.GenMarkdownTree(root, "../../doc")
+	if err != nil {
+		log.Fatalf("Failed to generate documenation, (%v)", err)
+	}
+}