mirror
/
cobra
mirror of https://github.com/spf13/cobra.git
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity
904 Commits 4 Branches 24 Tags 16 MiB
Commit Graph

150 Commits

Author SHA1 Message Date
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
Steve Francia ec63835b77 Add install instructions for the cobra binary (and library) 2015-11-20 09:55:10 -05:00
spf13 6c0cb34745 Restructure README.md 2015-11-19 08:34:15 -05:00
Anthony Fok 9324f3657d Copyedit README.md 2015-11-15 00:28:22 -07:00
Greg Osuri 6efbf0b624 README: added cmdns extension 2015-11-09 11:49:37 -05:00
Austin Riendeau 8208714c1b adds accidental removal of section back 2015-11-09 11:48:59 -05:00
Austin Riendeau d4c0084f5d changes README to have go code ran through gofmt 2015-11-09 11:48:59 -05:00
Austin Riendeau bc980b80a1 adds alternative error handling to readme 2015-11-06 08:44:35 -05:00
Jonathan Boulle 5c3dc12a87 README: correct name of rkt project 2015-11-06 08:42:26 -05:00
Eric Paris 57c62d3180 Merge pull request #173 from jojomi/master 
Update README.md
 2015-11-03 15:29:33 -05:00
Steve Francia a22f212832 Add clearer demo gif 2015-11-03 10:07:00 -05:00
Steve Francia 4f44cb7a62 Add demo gif to readme 2015-11-02 10:55:33 -05:00
Steve Francia ae5c01791c Add logo to readme 2015-11-02 10:53:04 -05:00
jojomi 5fa86d5a21 Update README.md 
Fixed typos with `Persistent`
 2015-10-30 22:01:50 +01:00
Tamir Duberstein e6d130ddfc README: fix CockroachDB typo 2015-10-29 15:31:43 -04:00
Steve Francia 2ab15e2b40 Add popular users and feature list to readme 2015-10-29 13:14:06 -04:00
Fabiano Franz a83a172122 Improve suggestions - add explicit SuggestFor attribute 2015-09-25 12:07:38 -03:00
Fabiano Franz b4087da7eb Allows command suggestions along with "unknown command" errors 2015-09-13 23:35:10 -03:00
Eric Paris 9e7788657f Auto generation of a man page 2015-08-21 01:10:13 -07:00
Scott Konzem 39e648c2b0 Fix typos in docs 2015-06-05 13:02:54 -04:00
Eric Paris fad5931693 Add docs, tests, and bit of rearrainging... 2015-04-30 14:08:47 -04:00
Sam Boyer 476e73f093 Fix misspelling typo 2015-04-26 08:53:29 -04:00
kballou f491ee284b Fix minor wording issue in README 2015-04-16 15:15:33 -06:00
Eric Paris 8a18f25809 Auto generation of markdown docs! 
An example from the kubernetes project, for the `kubectl config`
command, which as subcommands, and flags, and all sorts of stuff, it
will generate markdown like so:

config modifies .kubeconfig files

config modifies .kubeconfig files using subcommands like "kubectl config set current-context my-context"

```
kubectl config SUBCOMMAND
```

```
      --envvar=false: use the .kubeconfig from $KUBECONFIG
      --global=false: use the .kubeconfig from /home/username
  -h, --help=false: help for config
      --kubeconfig="": use a particular .kubeconfig file
      --local=false: use the .kubeconfig in the current directory
```

```
      --alsologtostderr=false: log to standard error as well as files
      --api-version="": The API version to use when talking to the server
  -a, --auth-path="": Path to the auth info file. If missing, prompt the user. Only used if using https.
      --certificate-authority="": Path to a cert. file for the certificate authority.
      --client-certificate="": Path to a client key file for TLS.
      --client-key="": Path to a client key file for TLS.
      --cluster="": The name of the kubeconfig cluster to use
      --context="": The name of the kubeconfig context to use
      --insecure-skip-tls-verify=false: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
      --log_backtrace_at=:0: when logging hits line file:N, emit a stack trace
      --log_dir=: If non-empty, write log files in this directory
      --log_flush_frequency=5s: Maximum number of seconds between log flushes
      --logtostderr=true: log to standard error instead of files
      --match-server-version=false: Require server version to match client version
      --namespace="": If present, the namespace scope for this CLI request.
      --password="": Password for basic authentication to the API server.
  -s, --server="": The address and port of the Kubernetes API server
      --stderrthreshold=2: logs at or above this threshold go to stderr
      --token="": Bearer token for authentication to the API server.
      --user="": The name of the kubeconfig user to use
      --username="": Username for basic authentication to the API server.
      --v=0: log level for V logs
      --validate=false: If true, use a schema to validate the input before sending it
      --vmodule=: comma-separated list of pattern=N settings for file-filtered logging
```

* [kubectl](kubectl.md)	 - kubectl controls the Kubernetes cluster manager
* [kubectl config set](kubectl_config_set.md)	 - Sets an individual value in a .kubeconfig file
* [kubectl config set-cluster](kubectl_config_set-cluster.md)	 - Sets a cluster entry in .kubeconfig
* [kubectl config set-context](kubectl_config_set-context.md)	 - Sets a context entry in .kubeconfig
* [kubectl config set-credentials](kubectl_config_set-credentials.md)	 - Sets a user entry in .kubeconfig
* [kubectl config unset](kubectl_config_unset.md)	 - Unsets an individual value in a .kubeconfig file
* [kubectl config use-context](kubectl_config_use-context.md)	 - Sets the current-context in a .kubeconfig file
* [kubectl config view](kubectl_config_view.md)	 - displays merged .kubeconfig settings or a specified .kubeconfig file.
 2015-04-12 14:40:34 -04:00
Eric Paris c746d30ef0 Merge pull request #69 from eparis/command-annotations 
Bash Autocompletion Generator
 2015-04-10 23:20:17 -05:00
Peter Dave Hello a40354f0bd Use svg instead of png to get better image quality 2015-04-10 07:15:21 +08:00
Eric Paris 9b2e6822e5 Add bash autocompletion generator 
Given a (potentially annotated) cobra command you can generate a bash
completion script.
 2015-04-07 20:13:49 -04:00
Étienne Vallette d'Osia 0e7e122c81 Add README section for RemoveCommand 2015-03-13 12:40:00 +09:00
Clayton Coleman 07a9dc0024 Update README.md to describe help behavior without subcommands 2015-02-11 17:18:36 -05:00
spf13 1cb31604a1 small formatting change to readme 2014-12-18 22:41:49 -05:00
Brad Dickason d8ec18ee74 Fixed typo :D 2014-09-08 12:00:28 -04:00
Hugo Leonardo Costa e Silva 8d72c1e167 Fix typo mistake on README 2014-08-06 00:22:50 -04:00
spf13 10a8494a87 Support for flags before commands 2014-06-17 12:32:27 -04:00
spf13 07be8145cc Adding support for --help 2014-06-17 12:28:42 -04:00
Alan Pearce 7ab4fd75e9 Fix grammar in readme 2014-05-27 14:54:43 -04:00
Ryan Cox 0330aef05c Fix small typo 2014-05-09 23:30:45 -04:00
Brandon Philips 2d10990d9e fix(README): simple grammar fixup 2014-01-11 21:34:06 -08:00
Steve Francia 88d4f7089f Merge pull request #5 from mcuadros/master 
Fixes in example
 2014-01-02 09:56:32 -08:00
Bitdeli Chef d7f66b2f69 Add a Bitdeli badge to README 2014-01-02 17:58:43 +00:00
Máximo Cuadros 1378a36255 Fixes in example 2013-12-21 11:32:14 +01:00
spf13 7216b06e83 Rewrote readme 2013-11-05 12:50:11 -05:00
spf13 88e482c582 Update read me example 2013-09-29 01:56:04 -04:00
spf13 c491be3a31 Adding Travis status image to readme 2013-09-24 17:08:47 -04:00
spf13 b6689aaea4 more in the readme 2013-09-24 16:52:33 -04:00
spf13 f0d16a4984 more complete readme 2013-09-24 16:45:20 -04:00
spf13 8f097506fc adding initial readme content 2013-09-03 18:45:49 -04:00
Steve Francia 7791653039 Initial commit 2013-09-03 13:40:26 -07:00