glenux-archive/spf13--cobra
1
0
Fork 0
mirror of https://github.com/spf13/cobra synced 2024-11-24 14:47:12 +00:00
Code Issues Projects Releases Packages Wiki Activity

adding nanobox/nanopack to list of cobra users

Browse source
This commit is contained in:
Steve Domino 2015-12-22 13:28:38 -07:00
parent c65e6422ff
commit 0ea548e1df
1 changed files with 15 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
README.md
View file

@ -15,9 +15,10 @@ Many of the most widely used Go projects are built using Cobra including:
* [Bleve](http://www.blevesearch.com/) * [Bleve](http://www.blevesearch.com/)
* [ProjectAtomic (enterprise)](http://www.projectatomic.io/) * [ProjectAtomic (enterprise)](http://www.projectatomic.io/)
* [Parse (CLI)](https://parse.com/) * [Parse (CLI)](https://parse.com/)
* [Nanobox](https://github.com/nanobox-io/nanobox)/[Nanopack](https://github.com/nanopack)
[![Build Status](https://travis-ci.org/spf13/cobra.svg "Travis CI status")](https://travis-ci.org/spf13/cobra) [![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) [![CircleCI status](https://circleci.com/gh/spf13/cobra.png?circle-token=:circle-token "CircleCI status")](https://circleci.com/gh/spf13/cobra)
![cobra](https://cloud.githubusercontent.com/assets/173412/10911369/84832a8e-8212-11e5-9f82-cc96660a4794.gif) ![cobra](https://cloud.githubusercontent.com/assets/173412/10911369/84832a8e-8212-11e5-9f82-cc96660a4794.gif)
@ -65,7 +66,7 @@ Cobra is built on a structure of commands, arguments & flags.
The best applications will read like sentences when used. Users will know how The best applications will read like sentences when used. Users will know how
to use the application because they will natively understand how to use it. to use the application because they will natively understand how to use it.
The pattern to follow is The pattern to follow is
`APPNAME VERB NOUN --ADJECTIVE.` `APPNAME VERB NOUN --ADJECTIVE.`
or or
`APPNAME COMMAND ARG --FLAG` `APPNAME COMMAND ARG --FLAG`
@ -329,7 +330,7 @@ var versionCmd = &cobra.Command{
} }
``` ```
### Attach command to its parent ### Attach command to its parent
If you notice in the above example we attach the command to its parent. In If you notice in the above example we attach the command to its parent. In
@ -473,18 +474,18 @@ The following output is automatically generated by Cobra. Nothing beyond the
command and flag definitions are needed. command and flag definitions are needed.
> hugo help > hugo help
hugo is the main command, used to build your Hugo site. hugo is the main command, used to build your Hugo site.
Hugo is a Fast and Flexible Static Site Generator Hugo is a Fast and Flexible Static Site Generator
built with love by spf13 and friends in Go. built with love by spf13 and friends in Go.
Complete documentation is available at http://gohugo.io/. Complete documentation is available at http://gohugo.io/.
Usage: Usage:
hugo [flags] hugo [flags]
hugo [command] hugo [command]
Available Commands: Available Commands:
server Hugo runs its own webserver to render the files server Hugo runs its own webserver to render the files
version Print the version number of Hugo version Print the version number of Hugo
@ -499,7 +500,7 @@ command and flag definitions are needed.
gendoc Generate Markdown documentation for the Hugo CLI. gendoc Generate Markdown documentation for the Hugo CLI.
genman Generate man page for Hugo genman Generate man page for Hugo
import Import your site from others. import Import your site from others.
Flags: Flags:
-b, --baseURL="": hostname (and path) to the root, e.g. http://spf13.com/ -b, --baseURL="": hostname (and path) to the root, e.g. http://spf13.com/
-D, --buildDrafts[=false]: include content marked as draft -D, --buildDrafts[=false]: include content marked as draft
@ -524,7 +525,7 @@ command and flag definitions are needed.
-v, --verbose[=false]: verbose output -v, --verbose[=false]: verbose output
--verboseLog[=false]: verbose logging --verboseLog[=false]: verbose logging
-w, --watch[=false]: watch filesystem for changes and recreate as needed -w, --watch[=false]: watch filesystem for changes and recreate as needed
Use "hugo [command] --help" for more information about a command. Use "hugo [command] --help" for more information about a command.
@ -576,7 +577,7 @@ embeds the usage as part of its output.
Usage: Usage:
hugo [flags] hugo [flags]
hugo [command] hugo [command]
Available Commands: Available Commands:
server Hugo runs its own webserver to render the files server Hugo runs its own webserver to render the files
version Print the version number of Hugo version Print the version number of Hugo
@ -591,7 +592,7 @@ embeds the usage as part of its output.
gendoc Generate Markdown documentation for the Hugo CLI. gendoc Generate Markdown documentation for the Hugo CLI.
genman Generate man page for Hugo genman Generate man page for Hugo
import Import your site from others. import Import your site from others.
Flags: Flags:
-b, --baseURL="": hostname (and path) to the root, e.g. http://spf13.com/ -b, --baseURL="": hostname (and path) to the root, e.g. http://spf13.com/
-D, --buildDrafts[=false]: include content marked as draft -D, --buildDrafts[=false]: include content marked as draft
@ -857,8 +858,8 @@ Libraries for extending Cobra:
Names in no particular order: Names in no particular order:
* [spf13](https://github.com/spf13), * [spf13](https://github.com/spf13),
[eparis](https://github.com/eparis), [eparis](https://github.com/eparis),
[bep](https://github.com/bep), and many more! [bep](https://github.com/bep), and many more!
## License ## License