Commit Graph

152 Commits

Author SHA1 Message Date
Ikko Ashimine a0aadc68eb
Spelling for GitHub CLI () 2022-07-07 07:54:19 +03:00
Andreas Deininger ffa8860dbe
Change links from http:// to https:// () 2022-05-17 14:28:13 -04:00
Neville Bokdawalla d622355c84
Changed branch name in the cobra generator link to 'main' () 2022-03-24 19:20:54 -04:00
John McBride 5b2b9e9f61
Removes viper dependency by removing cobra/ CLI tool ()
The cobra bootstrapping CLI tool has moved to
https://github.com/spf13/cobra-cli

Signed-off-by: John McBride <jmcbride@vmware.com>
2022-03-10 08:19:35 -07:00
Marian Steinbach 7cabfeb8f8
Update Go Doc link and badge ()
Use `pkg.go.dev` instead of `godoc.org`
2022-02-16 15:17:17 -07:00
Steve Francia cf87fc4e30 Updating generator documentation and links
Merging the updated documentation from the user_guide into the cobra/README.md.
Adding links as appropriate to both guides.
2021-11-03 15:36:51 -04:00
Steve Francia c97b7ece0b Update documentation to reflect the module aware generator 2021-11-03 15:36:51 -04:00
Unai Martinez-Corral f09e947637
readme: remove ToC, since it's now shown by GitHub () 2021-11-02 09:10:14 -06:00
umarcor d0f318d45b ci: deprecate Travis CI 2021-06-30 16:38:08 -04:00
umarcor ace6b14345 readme: split 'Getting Started' into 'user_guide.md' 2021-06-30 12:46:37 -04:00
Rob Playford 9a432671fd
fix home directory config not loading ()
leverage `viper.SetConfigType("yaml")` to fix issue regarding home directory configuration failing to load.
2021-06-15 19:52:13 -06:00
Anthony Fok 07445ea179
Copyedit shell-completion related documentation 2021-02-09 14:08:42 -07:00
Unai Martinez-Corral b73b344b63
ci: add GitHub Actions workflow 'Test' ()
Adds a "test" action which will run side by side (for now) with Travis

Co-authored-by: John McBride <jpmmcbride@gmail.com>
2021-02-09 08:48:59 -07:00
Unai Martinez-Corral 652c755d37
Use golangci-lint ()
Use golangci-lint. Repair warnings and errors resulting from linting.
2021-02-07 17:08:50 -07:00
zaataylor 39b5a91b20
README.md Readability Improvements ()
I made some small changes to the README.md file to enhance its readability.
2020-12-04 12:15:09 -07:00
Adam Demuri 142dfb15a8
Add example for making persistent flags required () 2020-10-14 09:53:09 -06:00
Alessio Treglia 40d34bca1b
Fix stderr printing functions ()
* Fix stderr printing functions

Follow-up of 

* Errors go to stderr as per POSIX

* use PrintErrf() instead of extra call to Sprintf()

* Error messages should always be printed to os.Stderr.

* add test case for Print* redirection

Thanks: @bukowa for the patch.
2020-10-01 09:28:00 -06:00
Arda Aytekin 8a39cb2614
Bug fix in README ()
Bug fixed in `README.md`.
2020-09-16 09:26:27 -06:00
Michael Samoylov 5cdf8e26ba
Fix typo () 2020-08-11 08:39:51 -04:00
Warren Fernandes a738b60e52
Add CONTRIBUTING.md () 2020-08-10 22:14:21 -06:00
Warren Fernandes 0e27f22f6e
Add slack badge to point to cobra slack channel () 2020-07-31 09:53:44 -06:00
Diana Flach 5d5290759a
Update README.md ()
I found this through a comment on an issue and thought this might save someone some time looking through the code.

fixes 
2020-07-10 14:06:59 -06:00
Marc Khouzam 2c5a0d300f
Extend Go completions and revamp zsh comp () ()
Replace the current Zsh completion with a Zsh completion solution based
on Go completions. This allows to support custom completions (based
on Go completions), but also to standardize the behavior of completion
across all shells.

Also, add support to Go completions for the bash completion annotations:
  BashCompFilenameExt (including Command.MarkFlagFilename() family)
                       - still supported by zsh
  BashCompSubdirsInDir - now supported by zsh
  BashCompOneRequiredFlag (including Command.MarkFlagRequired() family)
                       - now supported by zsh and fish

Finally, remove the suggestin of the = form of flag completion.
The = form is supported, but it will not be suggested to avoid having
duplicated suggestions.
2020-06-29 13:52:14 -06:00
John McBride e392f3204d
Man pages won't have auto gen tag when option is disabled ()
* Man pages wont have  auto gen tag when option is disabled

- this addresses 

* Add documentation for doc generation and a changelog
2020-04-29 11:15:55 -06:00
Warren Fernandes 090d94f474
Move projects using Cobra ()
Since there are so many projects using Cobra, we created a separate
document to list them
2020-04-16 11:00:24 -06:00
Julien 47414285f9
Add Github CLI to list of projects using Cobra () 2020-04-06 11:30:17 -06:00
Joshua Harshman bbffa3aa94
rm circle ci badge () 2020-04-01 10:27:47 -06:00
Andrea Falzetti 21cab29ef9
fix: undefined er () 2020-02-19 11:20:06 -05:00
XuZvvHYmZfYdWJNRunkJ c022f6fabd Update README.md ()
I think it meant to be `Echo` here instead of `Print` since the command is called `cmdEcho`.
2019-10-07 15:41:51 -06:00
Joshua Harshman 48e6ac4718
update doc w/ newer cmd/root.go example () 2019-10-07 15:31:10 -06:00
Joshua Harshman 3745fcd262
add goreportcard to readme () 2019-10-03 15:53:10 -06:00
Gregoire Mahe b80588d523 fix undefined cfgFile in documentation () 2019-08-05 09:56:17 -06:00
Carol A. Scott 9a31ddff0e Add Linkerd to list of projects using Cobra () 2019-07-12 09:55:10 -06:00
Go Frendi Gunawan 5f23f55c81 Update README.md
To avoid confusion, it is better to use `localCmd` instead of `rootCmd`
2019-06-07 10:47:24 -04:00
ialidzhikov 9eb9f5c66b Add gardenctl to projects build using Cobra
Signed-off-by: ialidzhikov <i.alidjikov@gmail.com>
2019-06-07 10:33:55 -04:00
Haim Ashkenazi dd577bdf31 zsh-completion: added zsh-completion documentation. 2019-06-07 10:09:50 -04:00
umarcor 5755ecf102 [TrivialPatches] Typos in README.md, fix and update CI, update projects list... ()
* update Example in README.md ()

* specify the color as the required arg ()

* command: fix typo in docstring of InheritedFlags ()

* add istio to the list of projects built with Cobra ()

* remove redundant 'else' ()

* add mattermost-server as a project built with Cobra ()

* update README.md ()

Fix the comment: consistent with others

* add uber/prototool as a project built with Cobra ()

* fix(ci): use go vet, update to Go 1.12, update shellcheck to v0.4.6 ()

* add go.mod and go.sum ()

* chore(travis): move 'diff' job to separate stage in Travis ()

* chore(travis): use language configuration list instead of explicit entries in matrix.include ()

* chore(travis): update shellcheck-docker to v0.6.0 ()

* update(README.md): separate projects by commas, instead of using a list

* chore: update viper to v1.3.2 and go-md2man to v1.0.10

* fix: convert CRLF to LF when comparing files

* use kyoh86/richgo to provide colored test outputs
2019-03-20 17:21:26 -04:00
bpdunni f619abc1d7 Added ExactValidArgs () 2018-10-21 10:01:21 -04:00
Garret Kelly 40172f1635 Remove unneeded imports from README.md example () 2018-10-18 10:37:54 -04:00
Alex Mayer 8d114be902 README: Remove Unneeded Newline () 2018-09-15 18:22:04 -04:00
Marian Steinbach 99dc123558 Replace Giant Swarm 'swarm' with 'gsctl' () 2018-08-29 12:07:45 -04:00
Federico 7c4570c3eb - Removed useless libraries in readme ()
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 ()
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 ()
* 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 ()
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 () 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 
2017-11-23 08:13:30 +01:00
Nick Miyake fb02817f3c Fix README example to be consistent with others ()
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 () 2017-11-17 00:24:59 -05:00
Paweł Słomka b3426bbac1 Remove confusing duplicate Execute from README () 2017-10-29 22:09:45 +01:00