feat: example builder utility (#223)

core/utils/example_builder/builder.go

@@ -0,0 +1,13 @@
+package examplebuilder
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/spf13/cobra"
+)
+
+// NewCmdExample adds example with description to the cobra.Command
+func NewCmdExample(cmd *cobra.Command, description string, flags []string) {
+	cmd.Example += fmt.Sprintf("\n\n# %s \n%s %s", description, cmd.CommandPath(), strings.Join(flags, ", "))
+}

docs/src/charmil_utils.md

@@ -0,0 +1,25 @@
+---
+title: Charmil Utils
+slug: /charmil_utils
+---
+
+## Example Builder
+Example Builder provides Example string builder which generates full example string of the cobra command and append to existing examples.
+
+NewCmdExample function accepts a cobra command in which example needs to be generated, description of the command and a slice of flags(if any)
+
+```go
+examplebuilder.NewCmdExample(cmd, "List all artifacts for the default artifacts group", []string{"list --page=4"})
+examplebuilder.NewCmdExample(cmd, "List all artifacts", []string{"list"})
+```
+
+Output
+```bash
+Examples:
+
+# List all artifacts for the default artifacts group 
+kafka list --page=4
+
+# List all artifacts 
+kafka list
+```