mirror
/
cobra
mirror of https://github.com/spf13/cobra.git
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity

changes README to have go code ran through gofmt

This commit is contained in:
Austin Riendeau 2015-11-07 18:37:52 -07:00 committed by spf13
parent 1e1d5137bf
commit d4c0084f5d
1 changed files with 78 additions and 95 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@ -119,6 +119,7 @@ The root command represents your binary itself.
Cobra doesn't require any special constructors. Simply create your commands. Cobra doesn't require any special constructors. Simply create your commands.
```go
var HugoCmd = &cobra.Command{ var HugoCmd = &cobra.Command{
Use: "hugo", Use: "hugo",
Short: "Hugo is a very fast static site generator", Short: "Hugo is a very fast static site generator",
@ -129,11 +130,13 @@ Cobra doesn't require any special constructors. Simply create your commands.
// Do Stuff Here // Do Stuff Here
}, },
} }
```
### Create additional commands ### Create additional commands
Additional commands can be defined. Additional commands can be defined.
```go
var versionCmd = &cobra.Command{ var versionCmd = &cobra.Command{
Use: "version", Use: "version",
Short: "Print the version number of Hugo", Short: "Print the version number of Hugo",
@ -142,6 +145,7 @@ Additional commands can be defined.
fmt.Println("Hugo Static Site Generator v0.9 -- HEAD") fmt.Println("Hugo Static Site Generator v0.9 -- HEAD")
}, },
} }
```
### Attach command to its parent ### Attach command to its parent
In this example we are attaching it to the root, but commands can be attached at any level. In this example we are attaching it to the root, but commands can be attached at any level.
@ -198,11 +202,14 @@ by not providing a 'Run' for the 'rootCmd'.
We have only defined one flag for a single command. We have only defined one flag for a single command.
More documentation about flags is available at https://github.com/spf13/pflag More documentation about flags is available at https://github.com/spf13/pflag
```go
package main
import ( import (
"github.com/spf13/cobra"
"fmt" "fmt"
"strings" "strings"
"github.com/spf13/cobra"
) )
func main() { func main() {
@ -250,7 +257,7 @@ More documentation about flags is available at https://github.com/spf13/pflag
cmdEcho.AddCommand(cmdTimes) cmdEcho.AddCommand(cmdTimes)
rootCmd.Execute() rootCmd.Execute()
} }
```
For a more complete example of a larger application, please checkout [Hugo](http://hugo.spf13.com) For a more complete example of a larger application, please checkout [Hugo](http://hugo.spf13.com)
## The Help Command ## The Help Command
@ -308,6 +315,7 @@ You can provide your own Help command or you own template for the default comman
The default help command is The default help command is
```go
func (c *Command) initHelp() { func (c *Command) initHelp() {
if c.helpCommand == nil { if c.helpCommand == nil {
c.helpCommand = &Command{ c.helpCommand = &Command{
@ -320,6 +328,7 @@ The default help command is
} }
c.AddCommand(c.helpCommand) c.AddCommand(c.helpCommand)
} }
```
You can provide your own command, function or template through the following methods. You can provide your own command, function or template through the following methods.
@ -462,32 +471,6 @@ Cobra also has functions where the return signature is an error. This allows for
**Example Usage using RunE:** **Example Usage using RunE:**
```go ```go
package main
import (
"errors"
"log"
"github.com/spf13/cobra"
)
func main() {
var rootCmd = &cobra.Command{
Use: "hugo",
Short: "Hugo is a very fast static site generator",
Long: `A Fast and Flexible Static Site Generator built with
love by spf13 and friends in Go.
Complete documentation is available at http://hugo.spf13.com`,
RunE: func(cmd *cobra.Command, args []string) error {
// Do Stuff Here
return errors.New("some random error")
},
}
if err := rootCmd.Execute(); err != nil {
log.Fatal(err)
}
}
``` ```
## Suggestions when "unknown command" happens ## Suggestions when "unknown command" happens