Albert Nigmatzianov
1723331773
Update documentation
2017-08-23 12:32:09 +05:00
Albert Nigmatzianov
8bcacfe133
Add more examples of Args field
2017-08-23 12:32:09 +05:00
joelterry
4a7b7e6586
*following
2017-08-20 07:33:59 +05:00
Albert Nigmatzianov
90fc11bbc0
Update README.md
2017-07-24 09:18:37 +02:00
Daniel Nephin
f20b4e9c32
Refactor TakesArgs to use an interface for arg validation.
...
Fix some typos in README and comments.
Move arg validation to after flag validation so that the help flag is run first.
Pass the same args to ValidateArgs as the Run methods receive.
Update README.
Signed-off-by: Daniel Nephin <dnephin@gmail.com>
2017-07-23 09:57:27 +02:00
Eric Paris
d89c499964
Allow commands to explicitly state if they do, or do not take arbitrary arguments
...
Check that arguments are in ValidArgs
If a command defined cmd.ValidArgs check that the argument is actually
in ValidArgs and fail if it is not.
2017-07-23 09:57:27 +02:00
Johanan Liebermann
4d647c8944
Print err instead of home
...
When 'home' can't be determined it doesn't make sense to print it.
The value of 'err' should be printed instead.
2017-06-24 17:01:00 +02:00
Johanan Liebermann
6471e3de04
Rename main func to initConfig
...
The function called `main` in the manual creation example should be called
`initConfig`.
2017-06-24 16:56:34 +02:00
Johanan Liebermann
f9d34972c1
Fix RootCmd var name
...
'rootCmd' should be 'RootCmd'.
2017-06-24 16:56:22 +02:00
Johanan Lieberman
d638dcb7c7
Improve readability of README
...
Improve punctuation, fix capitalization in a couple of places and
rephrase some sentences for better readability.
2017-06-23 19:56:08 +02:00
Brian Danowski
e458bb7ab8
Reword `become unexpected errors` to `encounter errors`
2017-06-23 16:17:13 +02:00
Albert Nigmatzianov
d7cfb13474
Update README.md
2017-06-09 21:55:21 +02:00
Martin Marcher
8d4ce3549a
Update README.md
...
Fix description to actually install generator as well as latest version of the library
2017-05-31 06:54:52 +02:00
Albert Nigmatzianov
e606913c4e
Fix typos
2017-05-28 12:56:30 +02:00
Albert Nigmatzianov
7918bf6886
Add explanation for viper.BindPflag in README.md
...
Fix #429
/cc @deltaskelta
2017-05-28 09:16:21 +02:00
Albert Nigmatzianov
ca5710c94e
Fix link to cobra lib in README.md
2017-05-19 22:27:40 +02:00
Robert Anthony Bellamy
4ba54a0f7f
Edit installation command in README.md ( #451 )
2017-05-19 21:09:26 +02:00
Don Petersen
90687e7bfc
Update pflag link in README ( #444 )
...
Cobra is not using ogier/pflag, but a fork of it.
2017-05-12 20:40:24 +02:00
Albert Nigmatzianov
1362f95a8d
Clean README.md ( #441 )
...
The release notes are obsolete and we better have a release notes
in Github releases
We don't need this TODO as we have godoc
And bitdeli doesn't work and doesn't supported for about 3 years.
2017-05-09 16:18:58 -04:00
Albert Nigmatzianov
1251aefb74
Rename Docker to Moby in README.md
2017-05-09 11:19:15 +02:00
Adrián López
c0bd07d7ba
Use cobra create instead of cobra init in README.md ( #396 )
2017-05-08 14:23:08 +02:00
Albert Nigmatzianov
32756eb440
cmd: Rewrite
2017-05-05 10:35:27 +02:00
Albert Nigmatzianov
8f0203be89
Update README.md
2017-05-02 08:49:35 +02:00
Albert Nigmatzianov
69f86e6d5d
Update README.md
...
See #269
2017-05-01 23:08:34 +02:00
Angel Beltran
bc8a58ff4d
docs: Update README.md
2017-05-01 16:51:43 +02:00
Albert Nigmatzianov
c68a90d2e8
Add built-in licenses info to README
2017-04-25 18:25:29 +02:00
Albert Nigmatzianov
63121c8814
Delete Parse from Go projects that uses cobra
...
http://blog.parse.com/announcements/a-parse-shutdown-reminder/
2017-04-23 22:42:44 +02:00
Nick Craig-Wood
a4f017e545
Add rclone to list of users ( #334 )
2017-04-23 22:25:25 +02:00
Francesc Campoy
c4f4d75ecc
Use go get so missing dependencies are fetched ( #406 )
...
If the developer is missing any dependencies, for instance `github.com/spf13/cobra/cobra`, `go install` will fail:
```bash
../../spf13/viper/util.go:29:2: cannot find package "gopkg.in/yaml.v2" in any of:
/Users/campoy/src/golang.org/x/go/src/gopkg.in/yaml.v2 (from $GOROOT)
/Users/campoy/src/gopkg.in/yaml.v2 (from $GOPATH)
```
While `go get github.com/spf13/cobra/cobra` will build the tool successfully.
2017-04-23 18:27:01 +02:00
Albert Nigmatzianov
10f6b9d7e1
Make `go path bin` clearer in README
...
Fix #324
2017-04-20 21:54:12 +02:00
korya
0a0df1e881
Use valid exit code value in `os.Exit` call ( #405 )
...
Exit code value range is 0-255. I think the examples in the main README document should be valid both syntactically and semantically.
2017-04-17 19:02:17 +02:00
Sebastiaan van Stijn
16c014f1a1
Add "docker" to readme
...
Docker (https://github.com/docker/docker ) now
also uses Cobra for the CLI. A majority of the
commands have been migrated (still some left),
but adding it already :)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2017-03-09 10:45:09 -05:00
Nikola Kovacs
24bb44aac8
Fix SilenceUsage and SilenceErrors in readme ( #397 )
...
You have to set them to true to silence the default output, not false.
2017-03-08 14:37:25 -05:00
Philipp Muens
de09d9ce07
Update README with missing import statements ( #373 )
2016-12-22 10:12:50 -05:00
Qinglan Peng
b62566898a
fmt package should be imported ( #370 )
...
Signed-off-by: Qinglan Peng <qinglanpeng@zju.edu.cn>
2016-12-14 10:19:52 -05:00
Cao Weiwei
4a087062c6
Fix typo
...
Signed-off-by: Cao Weiwei <cao.weiwei30@zte.com.cn>
2016-08-29 00:18:06 +08:00
Andrew Au
cb51c97a4e
Include instruction for building the cobra tool in README.md
2016-06-29 21:34:17 -07:00
Wesley Merkel
336d629de0
Add godoc badge to README.md ( #271 )
2016-04-30 09:18:32 -04:00
Ian Walter
9a8186dbb5
Improving createLicenseFile function
...
Also fixing typo in README example.
2016-04-27 12:03:26 -04:00
Ian Walter
d811f40c6a
Adding custom license functionality
...
* Refactoring code that unnecessarily declares a map before making it.
* Cleaning up gpl3 formatting to match other licenses.
* Adding functionality that allows specifying custom license header
and text in cobra config.
* Using license header and text as templates so that they can use
template variables (for custom and gpl3 licenses).
* Adding ability to specify no license.
* Adding custom license example to README.
2016-04-27 12:03:26 -04:00
Austin Riendeau
e21e5f0b09
updates readme to Explain SilenceErrors and SilenceUsage #225
2016-02-18 13:57:07 -07:00
Steve Francia
bbdcadf158
Add Swarm to Cobra user list
2016-02-08 17:02:59 -05:00
bogem
64cc91ac9b
Fix typo in README
2016-02-06 17:38:32 +01:00
Matt McCoy
d12e2412b6
Fix links to markdown and man page docs
2016-01-13 21:40:50 -05:00
Gyu-Ho Lee
2a426b5c59
README: add etcd
2016-01-06 16:54:07 -05:00
Steve Domino
f3aca0a8e7
adding nanobox/nanopack to list of cobra users
2015-12-24 08:54:09 -05:00
Tony Hsu
ebd5d2bdca
Update README.md
2015-12-09 15:48:54 +08:00
Tony Hsu
83de5c46ff
Fix wrong command name.
2015-12-08 17:17:31 +08:00
Steve Francia
e22a0c9315
Better instructions for the execute inside main()
2015-11-20 17:37:40 -05:00
Anthony Fok
4e18e0c2bf
Fix typos in README.md: Change "it's" to "its" where appropriate
2015-11-20 15:31:48 -07:00