mirror of https://github.com/knative/client.git
Support generating bash completion (#31)
* Support generating bash completion This patch adds subcommand to generate completion script for bash. As an knative user, we would like to complete subcommands and options rather than typing them. * Adds docs about bash auto completion in README.md This changeset adds auto-completion section in existing README.md Suggested-by: Navid Shaikh <nshaikh@redhat.com>
This commit is contained in:
parent
be50567b38
commit
c07254c46d
19
README.md
19
README.md
|
|
@ -27,3 +27,22 @@ $ go build ./cmd/...
|
|||
|
||||
- knative CLI must be built outside of the $GOPATH folder unless you explicitly use `export GO111MODULE=on`.
|
||||
- For building, Go `1.11.4` is required [due to a go mod issue](https://github.com/golang/go/issues/27925)
|
||||
|
||||
|
||||
**Bash auto completion:**
|
||||
|
||||
Run following to enable bash auto completion
|
||||
|
||||
```sh
|
||||
$ source <(kn completion)
|
||||
```
|
||||
|
||||
Use TAB to list available sub-commands
|
||||
|
||||
```sh
|
||||
$ kn <TAB>
|
||||
completion revision service
|
||||
|
||||
$ kn revision <TAB>
|
||||
describe list
|
||||
```
|
||||
|
|
|
|||
|
|
@ -0,0 +1,20 @@
|
|||
package commands
|
||||
|
||||
import (
|
||||
"os"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
func NewCompletionCommand(p *KnParams) *cobra.Command {
|
||||
completionCmd := &cobra.Command{
|
||||
Use: "completion",
|
||||
Short: "Output bash completion code",
|
||||
Run: completionAction,
|
||||
}
|
||||
return completionCmd
|
||||
}
|
||||
|
||||
func completionAction(cmd *cobra.Command, args []string) {
|
||||
cmd.Root().GenBashCompletion(os.Stdout)
|
||||
}
|
||||
|
|
@ -72,6 +72,7 @@ Eventing: Manage event subscriptions and channels. Connect up event sources.`,
|
|||
rootCmd.PersistentFlags().StringVar(&kubeCfgFile, "kubeconfig", "", "kubectl config file (default is $HOME/.kube/config)")
|
||||
rootCmd.AddCommand(NewServiceCommand(p))
|
||||
rootCmd.AddCommand(NewRevisionCommand(p))
|
||||
rootCmd.AddCommand(NewCompletionCommand(p))
|
||||
return rootCmd
|
||||
}
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue