x/urfave-cli
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #134 from Zearin/patch-1

Browse Source 
Minor README tweaks
This commit is contained in:
Jesse Szwedko 2014-08-27 20:51:55 -04:00
commit 7381bc4e62
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -9,17 +9,17 @@ http://godoc.org/github.com/codegangsta/cli
## Overview ## Overview
Command line apps are usually so tiny that there is absolutely no reason why your code should *not* be self-documenting. Things like generating help text and parsing command flags/options should not hinder productivity when writing a command line app. Command line apps are usually so tiny that there is absolutely no reason why your code should *not* be self-documenting. Things like generating help text and parsing command flags/options should not hinder productivity when writing a command line app.
This is where cli.go comes into play. cli.go makes command line programming fun, organized, and expressive! **This is where cli.go comes into play.** cli.go makes command line programming fun, organized, and expressive!
## Installation ## Installation
Make sure you have a working Go environment (go 1.1 is *required*). [See the install instructions](http://golang.org/doc/install.html). Make sure you have a working Go environment (go 1.1 is *required*). [See the install instructions](http://golang.org/doc/install.html).
To install cli.go, simply run: To install `cli.go`, simply run:
``` ```
$ go get github.com/codegangsta/cli $ go get github.com/codegangsta/cli
``` ```
Make sure your PATH includes to the `$GOPATH/bin` directory so your commands can be easily used: Make sure your `PATH` includes to the `$GOPATH/bin` directory so your commands can be easily used:
``` ```
export PATH=$PATH:$GOPATH/bin export PATH=$PATH:$GOPATH/bin
``` ```
@ -122,7 +122,7 @@ GLOBAL OPTIONS
``` ```
### Arguments ### Arguments
You can lookup arguments by calling the `Args` function on cli.Context. You can lookup arguments by calling the `Args` function on `cli.Context`.
``` go ``` go
... ...
@ -159,7 +159,7 @@ app.Action = func(c *cli.Context) {
#### Alternate Names #### Alternate Names
You can set alternate (or short) names for flags by providing a comma-delimited list for the Name. e.g. You can set alternate (or short) names for flags by providing a comma-delimited list for the `Name`. e.g.
``` go ``` go
app.Flags = []cli.Flag { app.Flags = []cli.Flag {
@ -173,7 +173,7 @@ app.Flags = []cli.Flag {
#### Values from the Environment #### Values from the Environment
You can also have the default value set from the environment via EnvVar. e.g. You can also have the default value set from the environment via `EnvVar`. e.g.
``` go ``` go
app.Flags = []cli.Flag { app.Flags = []cli.Flag {
@ -237,8 +237,8 @@ app.Commands = []cli.Command{
### Bash Completion ### Bash Completion
You can enable completion commands by setting the EnableBashCompletion You can enable completion commands by setting the `EnableBashCompletion`
flag on the App object. By default, this setting will only auto-complete to flag on the `App` object. By default, this setting will only auto-complete to
show an app's subcommands, but you can write your own completion methods for show an app's subcommands, but you can write your own completion methods for
the App or its subcommands. the App or its subcommands.
```go ```go
@ -270,8 +270,8 @@ app.Commands = []cli.Command{
#### To Enable #### To Enable
Source the autocomplete/bash_autocomplete file in your .bashrc file while Source the `autocomplete/bash_autocomplete` file in your `.bashrc` file while
setting the PROG variable to the name of your program: setting the `PROG` variable to the name of your program:
`PROG=myprogram source /.../cli/autocomplete/bash_autocomplete` `PROG=myprogram source /.../cli/autocomplete/bash_autocomplete`