A pull request for gnmic prompt mode

.gitignore

@@ -2,3 +2,5 @@ _test/
 builds/
 dist
 *.log
+gnmic
+*.tmp

README.md

@@ -58,3 +58,10 @@ gnmic -a 10.1.0.11:57400 -u admin -p admin --insecure \
 gnmic -a 10.1.0.11:57400 -u admin -p admin --insecure \
       sub --path "/state/port[port-id=1/1/c1/1]/statistics/in-packets"
 ```
+
+### Prompt mode
+
+The prompt mode is an interactive mode of the gnmic CLI client for user convenience.
+The gnmic subcommands such as capabilities, get, set and subscribe of the gNMI protocol can be used in the prompt mode with tab completion for their flags and the xpath of the YANG data models that you defined.
+
+![gnmic prompt-mode](docs/images/gnmic.prompt-mode.demo.gif)

cmd/capabilities.go

@@ -34,9 +34,8 @@ var printVersion bool
 // capabilitiesCmd represents the capabilities command
 var capabilitiesCmd = &cobra.Command{
 	Use:     "capabilities",
-	Aliases: []string{"c", "cap"},
+	Aliases: []string{"cap"},
 	Short:   "query targets gnmi capabilities",
-
 	RunE: func(cmd *cobra.Command, args []string) error {
 		if viper.GetString("format") == "event" {
 			return fmt.Errorf("format event not supported for Capabilities RPC")
@@ -57,6 +56,7 @@ var capabilitiesCmd = &cobra.Command{
 		wg.Wait()
 		return nil
 	},
+	SilenceUsage: true,
 }
 
 func reqCapability(ctx context.Context, target *collector.Target, wg *sync.WaitGroup, lock *sync.Mutex) {
@@ -107,7 +107,6 @@ func reqCapability(ctx context.Context, target *collector.Target, wg *sync.WaitG
 
 func init() {
 	rootCmd.AddCommand(capabilitiesCmd)
-	capabilitiesCmd.SilenceUsage = true
 	capabilitiesCmd.Flags().BoolVarP(&printVersion, "version", "", false, "show gnmi version only")
 	viper.BindPFlag("capabilities-version", capabilitiesCmd.LocalFlags().Lookup("version"))
 }

cmd/get.go

@@ -34,6 +34,11 @@ var paths []string
 var getCmd = &cobra.Command{
 	Use:   "get",
 	Short: "run gnmi get on targets",
+	Annotations: map[string]string{
+		"--path":   "XPATH",
+		"--prefix": "XPATH",
+		"--model":  "MODEL",
+	},
 
 	RunE: func(cmd *cobra.Command, args []string) error {
 		if viper.GetString("format") == "event" {
@@ -59,6 +64,11 @@ var getCmd = &cobra.Command{
 		wg.Wait()
 		return nil
 	},
+	PostRun: func(cmd *cobra.Command, args []string) {
+		cmd.ResetFlags()
+		initGetFlags(cmd)
+	},
+	SilenceUsage: true,
 }
 
 func getRequest(ctx context.Context, req *gnmi.GetRequest, target *collector.Target, wg *sync.WaitGroup, lock *sync.Mutex) {
@@ -120,19 +130,23 @@ func getRequest(ctx context.Context, req *gnmi.GetRequest, target *collector.Tar
 
 func init() {
 	rootCmd.AddCommand(getCmd)
-	getCmd.SilenceUsage = true
-	getCmd.Flags().StringArrayVarP(&paths, "path", "", []string{}, "get request paths")
-	getCmd.MarkFlagRequired("path")
-	getCmd.Flags().StringP("prefix", "", "", "get request prefix")
-	getCmd.Flags().StringSliceP("model", "", []string{}, "get request models")
-	getCmd.Flags().StringP("type", "t", "ALL", "data type requested from the target. one of: ALL, CONFIG, STATE, OPERATIONAL")
-	getCmd.Flags().StringP("target", "", "", "get request target")
+	initGetFlags(getCmd)
+}
+
+// used to init or reset getCmd flags for gnmic-prompt mode
+func initGetFlags(cmd *cobra.Command) {
+	cmd.Flags().StringArrayVarP(&paths, "path", "", []string{}, "get request paths")
+	cmd.MarkFlagRequired("path")
+	cmd.Flags().StringP("prefix", "", "", "get request prefix")
+	cmd.Flags().StringSliceP("model", "", []string{}, "get request models")
+	cmd.Flags().StringP("type", "t", "ALL", "data type requested from the target. one of: ALL, CONFIG, STATE, OPERATIONAL")
+	cmd.Flags().StringP("target", "", "", "get request target")
 
-	viper.BindPFlag("get-path", getCmd.LocalFlags().Lookup("path"))
-	viper.BindPFlag("get-prefix", getCmd.LocalFlags().Lookup("prefix"))
-	viper.BindPFlag("get-model", getCmd.LocalFlags().Lookup("model"))
-	viper.BindPFlag("get-type", getCmd.LocalFlags().Lookup("type"))
-	viper.BindPFlag("get-target", getCmd.LocalFlags().Lookup("target"))
+	viper.BindPFlag("get-path", cmd.LocalFlags().Lookup("path"))
+	viper.BindPFlag("get-prefix", cmd.LocalFlags().Lookup("prefix"))
+	viper.BindPFlag("get-model", cmd.LocalFlags().Lookup("model"))
+	viper.BindPFlag("get-type", cmd.LocalFlags().Lookup("type"))
+	viper.BindPFlag("get-target", cmd.LocalFlags().Lookup("target"))
 }
 
 func createGetRequest() (*gnmi.GetRequest, error) {

cmd/listen.go

@@ -40,7 +40,6 @@ import (
 var listenCmd = &cobra.Command{
 	Use:   "listen",
 	Short: "listens for telemetry dialout updates from the node",
-
 	RunE: func(cmd *cobra.Command, args []string) error {
 		ctx, cancel := context.WithCancel(context.Background())
 		defer cancel()
@@ -114,11 +113,11 @@ var listenCmd = &cobra.Command{
 		defer server.grpcServer.Stop()
 		return nil
 	},
+	SilenceUsage: true,
 }
 
 func init() {
 	rootCmd.AddCommand(listenCmd)
-	listenCmd.SilenceUsage = true
 	listenCmd.Flags().Uint32P("max-concurrent-streams", "", 256, "max concurrent streams gnmic can receive per transport")
 
 	viper.BindPFlag("listen-max-concurrent-streams", listenCmd.LocalFlags().Lookup("max-concurrent-streams"))