-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
completion.go
74 lines (62 loc) · 2.37 KB
/
completion.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
/*
Copyright 2019 The Kubernetes Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
// Package completion implements the `completion` command
package completion
import (
"errors"
"github.com/spf13/cobra"
"sigs.k8s.io/kind/pkg/cmd"
"sigs.k8s.io/kind/pkg/cmd/kind/completion/bash"
"sigs.k8s.io/kind/pkg/cmd/kind/completion/fish"
"sigs.k8s.io/kind/pkg/cmd/kind/completion/zsh"
"sigs.k8s.io/kind/pkg/log"
)
// NewCommand returns a new cobra.Command for cluster creation
func NewCommand(logger log.Logger, streams cmd.IOStreams) *cobra.Command {
cmd := &cobra.Command{
Args: cobra.NoArgs,
Use: "completion",
Short: "Output shell completion code for the specified shell (bash, zsh or fish)",
Long: longDescription,
RunE: func(cmd *cobra.Command, args []string) error {
err := cmd.Help()
if err != nil {
return err
}
return errors.New("Subcommand is required")
},
}
cmd.AddCommand(zsh.NewCommand(logger, streams))
cmd.AddCommand(bash.NewCommand(logger, streams))
cmd.AddCommand(fish.NewCommand(logger, streams))
return cmd
}
const longDescription = `
Outputs kind shell completion for the given shell (bash or zsh)
This depends on the bash-completion binary. Example installation instructions:
# for bash users
$ kind completion bash > ~/.kind-completion
$ source ~/.kind-completion
# for zsh users
% kind completion zsh > /usr/local/share/zsh/site-functions/_kind
% autoload -U compinit && compinit
# or if zsh-completion is installed via homebrew
% kind completion zsh > "${fpath[1]}/_kind"
# or if you use oh-my-zsh (needs zsh-completions plugin)
% mkdir $ZSH/completions/
% kind completion zsh > $ZSH/completions/_kind
# for fish users
% kind completion fish > ~/.config/fish/completions/kind.fish
Additionally, you may want to output the completion to a file and source in your .bashrc
Note for zsh users: [1] zsh completions are only supported in versions of zsh >= 5.2
`