golang/mikael/madonctl: comparison vendor/github.com/spf13/cobra/README.md

equal deleted inserted replaced

-:c040f992052f
+:1c52a0eeb952
 ![cobra logo](https://cloud.githubusercontent.com/assets/173412/10886352/ad566232-814f-11e5-9cd0-aa101788c117.png)
 Cobra is both a library for creating powerful modern CLI applications as well as a program to generate applications and command files.
-Many of the most widely used Go projects are built using Cobra including:
+Many of the most widely used Go projects are built using Cobra, such as:
+[Kubernetes](http://kubernetes.io/),
-* [Kubernetes](http://kubernetes.io/)
+[Hugo](http://gohugo.io),
-* [Hugo](http://gohugo.io)
+[rkt](https://github.com/coreos/rkt),
-* [rkt](https://github.com/coreos/rkt)
+[etcd](https://github.com/coreos/etcd),
-* [etcd](https://github.com/coreos/etcd)
+[Moby (former Docker)](https://github.com/moby/moby),
-* [Moby (former Docker)](https://github.com/moby/moby)
+[Docker (distribution)](https://github.com/docker/distribution),
-* [Docker (distribution)](https://github.com/docker/distribution)
+[OpenShift](https://www.openshift.com/),
-* [OpenShift](https://www.openshift.com/)
+[Delve](https://github.com/derekparker/delve),
-* [Delve](https://github.com/derekparker/delve)
+[GopherJS](http://www.gopherjs.org/),
-* [GopherJS](http://www.gopherjs.org/)
+[CockroachDB](http://www.cockroachlabs.com/),
-* [CockroachDB](http://www.cockroachlabs.com/)
+[Bleve](http://www.blevesearch.com/),
-* [Bleve](http://www.blevesearch.com/)
+[ProjectAtomic (enterprise)](http://www.projectatomic.io/),
-* [ProjectAtomic (enterprise)](http://www.projectatomic.io/)
+[Giant Swarm's gsctl](https://github.com/giantswarm/gsctl),
-* [GiantSwarm's swarm](https://github.com/giantswarm/cli)
+[Nanobox](https://github.com/nanobox-io/nanobox)/[Nanopack](https://github.com/nanopack),
-* [Nanobox](https://github.com/nanobox-io/nanobox)/[Nanopack](https://github.com/nanopack)
+[rclone](http://rclone.org/),
-* [rclone](http://rclone.org/)
+[nehm](https://github.com/bogem/nehm),
-* [nehm](https://github.com/bogem/nehm)
+[Pouch](https://github.com/alibaba/pouch),
-* [Pouch](https://github.com/alibaba/pouch)
+[Istio](https://istio.io),
+[Prototool](https://github.com/uber/prototool),
+[mattermost-server](https://github.com/mattermost/mattermost-server),
+[Gardener](https://github.com/gardener/gardenctl),
+etc.
 [![Build Status](https://travis-ci.org/spf13/cobra.svg "Travis CI status")](https://travis-ci.org/spf13/cobra)
 [![CircleCI status](https://circleci.com/gh/spf13/cobra.png?circle-token=:circle-token "CircleCI status")](https://circleci.com/gh/spf13/cobra)
 [![GoDoc](https://godoc.org/github.com/spf13/cobra?status.svg)](https://godoc.org/github.com/spf13/cobra)
 * [Usage Message](#usage-message)
 * [PreRun and PostRun Hooks](#prerun-and-postrun-hooks)
 * [Suggestions when "unknown command" happens](#suggestions-when-unknown-command-happens)
 * [Generating documentation for your command](#generating-documentation-for-your-command)
 * [Generating bash completions](#generating-bash-completions)
+* [Generating zsh completions](#generating-zsh-completions)
 - [Contributing](#contributing)
 - [License](#license)
 # Overview
 ```go
 package main
 import (
-"fmt"
-"os"
 "{pathToYourApp}/cmd"
 )
 func main() {
 cmd.Execute()
 ```go
 package main
 import (
-"fmt"
-"os"
 "{pathToYourApp}/cmd"
 )
 func main() {
 cmd.Execute()
 ### Local Flags
 A flag can also be assigned locally which will only apply to that specific command.
 ```go
-rootCmd.Flags().StringVarP(&Source, "source", "s", "", "Source directory to read from")
+localCmd.Flags().StringVarP(&Source, "source", "s", "", "Source directory to read from")
 ```
 ### Local Flag on Parent Commands
 By default Cobra only parses local flags on the target command, any local flags on
 - `ArbitraryArgs` - the command will accept any args.
 - `OnlyValidArgs` - the command will report an error if there are any positional args that are not in the `ValidArgs` field of `Command`.
 - `MinimumNArgs(int)` - the command will report an error if there are not at least N positional args.
 - `MaximumNArgs(int)` - the command will report an error if there are more than N positional args.
 - `ExactArgs(int)` - the command will report an error if there are not exactly N positional args.
+- `ExactValidArgs(int)` - the command will report an error if there are not exactly N positional args OR if there are any positional args that are not in the `ValidArgs` field of `Command`
 - `RangeArgs(min, max)` - the command will report an error if the number of args is not between the minimum and maximum number of expected args.
 An example of setting the custom validator:
 ```go
 var cmd = &cobra.Command{
 Short: "hello",
 Args: func(cmd *cobra.Command, args []string) error {
 if len(args) < 1 {
-return errors.New("requires at least one arg")
+return errors.New("requires a color argument")
 }
 if myapp.IsValidColor(args[0]) {
 return nil
 }
 return fmt.Errorf("invalid color specified: %s", args[0])
 fmt.Println("Print: " + strings.Join(args, " "))
 },
 }
 var cmdTimes = &cobra.Command{
-Use:   "times [# times] [string to echo]",
+Use:   "times [string to echo]",
 Short: "Echo anything to the screen more times",
 Long: `echo things multiple times back to the user by providing
 a count and a string.`,
 Args: cobra.MinimumNArgs(1),
 Run: func(cmd *cobra.Command, args []string) {
 ## Generating bash completions
 Cobra can generate a bash-completion file. If you add more information to your command, these completions can be amazingly powerful and flexible.  Read more about it in [Bash Completions](bash_completions.md).
+## Generating zsh completions
+Cobra can generate zsh-completion file. Read more about it in
+[Zsh Completions](zsh_completions.md).
 # Contributing
 1. Fork it
 2. Download your fork to your PC (`git clone https://github.com/your_username/cobra && cd cobra`)
 3. Create your feature branch (`git checkout -b my-new-feature`)

changeset 251	1c52a0eeb952
parent 242	2a9ec03fe5a1
child 256	6d9efbef00a9