func printOptions(w io.Writer, cmd *cobra.Command, name string) error { flags := cmd.NonInheritedFlags() flags.SetOutput(w) if flags.HasFlags() { if _, err := fmt.Fprintf(w, "### Options\n\n```\n"); err != nil { return err } flags.PrintDefaults() if _, err := fmt.Fprintf(w, "```\n\n"); err != nil { return err } } parentFlags := cmd.InheritedFlags() parentFlags.SetOutput(w) if parentFlags.HasFlags() { if _, err := fmt.Fprintf(w, "### Options inherited from parent commands\n\n```\n"); err != nil { return err } parentFlags.PrintDefaults() if _, err := fmt.Fprintf(w, "```\n\n"); err != nil { return err } } return nil }
func genYaml(command *cobra.Command, parent, docsDir string) { doc := cmdDoc{} doc.Name = command.Name() doc.Synopsis = forceMultiLine(command.Short) doc.Description = forceMultiLine(command.Long) flags := command.NonInheritedFlags() if flags.HasFlags() { doc.Options = genFlagResult(flags) } flags = command.InheritedFlags() if flags.HasFlags() { doc.InheritedOptions = genFlagResult(flags) } if len(command.Example) > 0 { doc.Example = command.Example } if len(command.Commands()) > 0 || len(parent) > 0 { result := make([]string, 0) if len(parent) > 0 { result = append(result, parent) } for _, c := range command.Commands() { result = append(result, c.Name()) } doc.SeeAlso = result } final, err := yaml.Marshal(&doc) if err != nil { fmt.Println(err) os.Exit(1) } var filename string if parent == "" { filename = docsDir + doc.Name + ".yaml" } else { filename = docsDir + parent + "_" + doc.Name + ".yaml" } outFile, err := os.Create(filename) if err != nil { fmt.Println(err) os.Exit(1) } defer outFile.Close() _, err = outFile.Write(final) if err != nil { fmt.Println(err) os.Exit(1) } }
func NewCommand(c *cobra.Command, path string) *Command { return &Command{ Name: c.Name(), Path: path, Description: c.Long, Synopsis: c.Short, Example: c.Example, Options: NewOptions(c.NonInheritedFlags()), InheritedOptions: NewOptions(c.InheritedFlags()), Usage: c.Use, } }
func (c *CLI) globalFlags(cmd *cobra.Command) *flag.FlagSet { fs := &flag.FlagSet{} if cmd.HasParent() { fs.AddFlagSet(cmd.InheritedFlags()) if fs.Lookup("help") == nil && cmd.Flag("help") != nil { fs.AddFlag(cmd.Flag("help")) } } else { fs.AddFlagSet(cmd.PersistentFlags()) } return c.sansDriverFlags(c.sansAdditionalFlags(fs)) }
func mustClientFromCmd(cmd *cobra.Command) *clientv3.Client { flags.SetPflagsFromEnv("ETCDCTL", cmd.InheritedFlags()) endpoints, err := cmd.Flags().GetStringSlice("endpoints") if err != nil { ExitWithError(ExitError, err) } dialTimeout := dialTimeoutFromCmd(cmd) sec := secureCfgFromCmd(cmd) return mustClient(endpoints, dialTimeout, sec) }
func manPrintOptions(out io.Writer, command *cobra.Command) { flags := command.NonInheritedFlags() if flags.HasFlags() { fmt.Fprintf(out, "# OPTIONS\n") manPrintFlags(out, flags) fmt.Fprintf(out, "\n") } flags = command.InheritedFlags() if flags.HasFlags() { fmt.Fprintf(out, "# OPTIONS INHERITED FROM PARENT COMMANDS\n") manPrintFlags(out, flags) fmt.Fprintf(out, "\n") } }
// getAnchnetClient returns the path to configuration file. func getAnchnetClient(cmd *cobra.Command) *anchnet.Client { f := cmd.InheritedFlags().Lookup("config-path") p := cmd.InheritedFlags().Lookup("project") z := cmd.InheritedFlags().Lookup("zone") if f == nil { fmt.Fprintln(os.Stderr, "flag accessed but not defined for command %s: config-path", cmd.Name()) os.Exit(1) } path := f.Value.String() if path == "" { path = anchnet.DefaultConfigPath() } if p == nil { fmt.Fprintln(os.Stderr, "flag accessed but not defined for command %s: project", cmd.Name()) os.Exit(1) } if z == nil { fmt.Fprintln(os.Stderr, "flag accessed but not defined for command %s: zone", cmd.Name()) os.Exit(1) } auth, err := anchnet.LoadConfig(path) if err != nil { fmt.Fprintln(os.Stderr, "error loading auth config: %v", err) os.Exit(1) } // we only set ProjectId if --project is set because // projectid can also be set in config file itself already project := p.Value.String() if project != "" { auth.ProjectId = project } client, err := anchnet.NewClient(anchnet.DefaultEndpoint, auth) zone := z.Value.String() if zone != "" { client.SetZone(zone) } if err != nil { fmt.Fprintln(os.Stderr, "error creating client: %v", err) os.Exit(1) } return client }
// epHealthCommandFunc executes the "endpoint-health" command. func epHealthCommandFunc(cmd *cobra.Command, args []string) { flags.SetPflagsFromEnv("ETCDCTL", cmd.InheritedFlags()) endpoints, err := cmd.Flags().GetStringSlice("endpoints") if err != nil { ExitWithError(ExitError, err) } sec := secureCfgFromCmd(cmd) dt := dialTimeoutFromCmd(cmd) auth := authCfgFromCmd(cmd) cfgs := []*v3.Config{} for _, ep := range endpoints { cfg, err := newClientCfg([]string{ep}, dt, sec, auth) if err != nil { ExitWithError(ExitBadArgs, err) } cfgs = append(cfgs, cfg) } var wg sync.WaitGroup for _, cfg := range cfgs { wg.Add(1) go func(cfg *v3.Config) { defer wg.Done() ep := cfg.Endpoints[0] cli, err := v3.New(*cfg) if err != nil { fmt.Printf("%s is unhealthy: failed to connect: %v\n", ep, err) return } st := time.Now() // get a random key. As long as we can get the response without an error, the // endpoint is health. ctx, cancel := commandCtx(cmd) _, err = cli.Get(ctx, healthCheckKey) cancel() if err != nil { fmt.Printf("%s is unhealthy: failed to commit proposal: %v\n", ep, err) } else { fmt.Printf("%s is healthy: successfully committed proposal: took = %v\n", ep, time.Since(st)) } }(cfg) } wg.Wait() }
func printOptions(out *bytes.Buffer, command *cobra.Command, name string) { flags := command.NonInheritedFlags() flags.SetOutput(out) if flags.HasFlags() { fmt.Fprintf(out, "### Options\n\n```\n") flags.PrintDefaults() fmt.Fprintf(out, "```\n\n") } parentFlags := command.InheritedFlags() parentFlags.SetOutput(out) if parentFlags.HasFlags() { fmt.Fprintf(out, "### Options inherrited from parent commands\n\n```\n") parentFlags.PrintDefaults() fmt.Fprintf(out, "```\n\n") } }
func usageFunc(cmd *cobra.Command) error { subCommands := getSubCommands(cmd) tabOut := getTabOutWithWriter(os.Stdout) commandUsageTemplate.Execute(tabOut, struct { Cmd *cobra.Command LocalFlags string GlobalFlags string SubCommands []*cobra.Command Version string }{ cmd, rktFlagUsages(cmd.LocalFlags()), rktFlagUsages(cmd.InheritedFlags()), subCommands, version.Version, }) tabOut.Flush() return nil }
func GenerateSingle(cmd *cobra.Command, out *bytes.Buffer, linkHandler func(string) string, specs []string, render_dir string) { name := cmd.CommandPath() short := cmd.Short long := cmd.Long if len(long) == 0 { long = short } fmt.Fprintf(out, "# %s\n\n", name) fmt.Fprintf(out, "%s\n\n", short) fmt.Fprintf(out, "## Synopsis\n") fmt.Fprintf(out, "\n%s\n\n", long) if cmd.Runnable() { fmt.Fprintf(out, "```bash\n%s\n```\n\n", cmd.UseLine()) } if len(cmd.Example) > 0 { fmt.Fprintf(out, "## Examples\n\n") fmt.Fprintf(out, "```bash\n%s\n```\n\n", cmd.Example) } flags := cmd.NonInheritedFlags() flags.SetOutput(out) if flags.HasFlags() { fmt.Fprintf(out, "## Options\n\n```\n") flags.PrintDefaults() fmt.Fprintf(out, "```\n\n") } parentFlags := cmd.InheritedFlags() parentFlags.SetOutput(out) if parentFlags.HasFlags() { fmt.Fprintf(out, "## Options inherited from parent commands\n\n```\n") parentFlags.PrintDefaults() fmt.Fprintf(out, "```\n\n") } if len(cmd.Commands()) > 0 { fmt.Fprintf(out, "## Subcommands\n\n") children := cmd.Commands() sort.Sort(byName(children)) for _, child := range children { if len(child.Deprecated) > 0 { continue } cname := name + " " + child.Name() link := cname + ".md" link = strings.Replace(link, " ", "_", -1) fmt.Fprintf(out, "* [%s](%s)\t - %s\n", cname, linkHandler(link), child.Short) } } if len(cmd.Commands()) > 0 && cmd.HasParent() { fmt.Fprintf(out, "\n") } if cmd.HasParent() { fmt.Fprintf(out, "## See Also\n\n") parent := cmd.Parent() pname := parent.CommandPath() link := pname + ".md" link = strings.Replace(link, " ", "_", -1) fmt.Fprintf(out, "* [%s](%s)\t - %s\n", pname, linkHandler(link), parent.Short) } fmt.Fprintf(out, "\n## Specifications\n\n") for _, spec := range specs { spec = strings.Replace(spec, render_dir, "", 1) title := strings.Replace(spec, "_", " ", -1) title = strings.Replace(title, ".md", "", 1) // title = strings.Replace(title, "spec", "specification", 1) title = strings.Title(title) fmt.Fprintf(out, "* [%s](%s)\n", title, linkHandler(spec)) } fmt.Fprintf(out, "\n") }