Federico
7c4570c3eb
#716 - Removed useless libraries in readme ( #717 )
...
Signed-off-by: Federico <federico@imaginecurve.com>
2018-07-22 17:56:44 -04:00
Phillip Johnsen
93959269ad
Add Execute func example in README.md ( #629 )
...
Trivial addition to the first example in `README.md` that defines the
`cmd.Execute()` function that is referenced further down in the `main.go`
example.
2018-02-05 14:42:58 -08:00
Jake Dodd
c2bbfaa12d
Add usage example for required flags ( #627 )
...
* Add usage example for required flags
* Explain new behavior in MarkFlagRequired godocs
2018-02-05 11:53:53 -08:00
Allen Sun
de2d9c4eca
Add alibaba/pouch in README.md ( #593 )
...
Signed-off-by: Allen Sun <shlallen1990@gmail.com>
2017-12-04 14:13:25 +01:00
Nick Miyake
86783686ca
Add documentation for '--version' flag to README ( #590 )
2017-12-02 18:59:49 +01:00
Nick Miyake
1be1d2841c
Make rootCmd private
...
Update Cobra generator to make rootCmd private rather than
exporting it. Also update examples in README to use the exported
Execute() command rather than referencing unexported rootCmd.
Fixes #556
2017-11-23 08:13:30 +01:00
Nick Miyake
fb02817f3c
Fix README example to be consistent with others ( #585 )
...
Alphabetize and separate builtin imports from external imports
to be gofmt-compliant and consistent with other examples in README.
2017-11-22 16:30:46 -05:00
Tyler Butler
d6948b782c
Fix minor typo ( #579 )
2017-11-17 00:24:59 -05:00
Paweł Słomka
b3426bbac1
Remove confusing duplicate Execute from README ( #554 )
2017-10-29 22:09:45 +01:00
Daniel Nephin
83b1f03962
Add a TraverseChildren option to allow for flags on each command in the hierarchy ( #299 )
...
Fix #277
Fix #467
2017-10-07 23:29:11 +02:00
Shahidh K Muhammed
419e0f8d51
doc: add ReST doc generation ( #537 )
2017-10-07 19:39:47 +02:00
Albert Nigmatzianov
bc69223348
Fix dead link in README for cobra generator
...
Fix #542
2017-10-06 21:18:12 +02:00
Albert Nigmatzianov
e8e7fe0355
Shorten README
...
Fix #501
2017-10-06 12:20:24 +02:00
Albert Nigmatzianov
2df9a53181
Fix MinimumArgs
2017-08-23 12:32:09 +05:00
Albert Nigmatzianov
cb747385b3
Retab README.md
2017-08-23 12:32:09 +05:00
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