suyiiyii/yq
1
0
Fork 0
mirror of https://github.com/mikefarah/yq.git synced 2024-12-19 20:19:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix: shell-completion (#2006)

Browse Source 
* fix: shell-completion

* update: description
This commit is contained in:
Cory Latschkowski 2024-04-21 23:15:36 -05:00 committed by GitHub
parent b54d7eb21c
commit 21ba506edb
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -349,7 +349,6 @@ Available Commands:
eval (default) Apply the expression to each document in each yaml file in sequence eval (default) Apply the expression to each document in each yaml file in sequence
eval-all Loads _all_ yaml documents of _all_ yaml files and runs expression once eval-all Loads _all_ yaml documents of _all_ yaml files and runs expression once
help Help about any command help Help about any command
shell-completion Generate completion script
Flags: Flags:
-C, --colors force print with colors -C, --colors force print with colors

17
cmd/shell-completion.go → cmd/completion.go
View File

@ -7,19 +7,20 @@ import (
) )
var completionCmd = &cobra.Command{ var completionCmd = &cobra.Command{
Use: "shell-completion [bash|zsh|fish|powershell]", Use: "completion [bash|zsh|fish|powershell]",
Short: "Generate completion script", Aliases: []string{"shell-completion"},
Short: "Generate the autocompletion script for the specified shell",
Long: `To load completions: Long: `To load completions:
Bash: Bash:
$ source <(yq shell-completion bash) $ source <(yq completion bash)
# To load completions for each session, execute once: # To load completions for each session, execute once:
Linux: Linux:
$ yq shell-completion bash > /etc/bash_completion.d/yq $ yq completion bash > /etc/bash_completion.d/yq
MacOS: MacOS:
$ yq shell-completion bash > /usr/local/etc/bash_completion.d/yq $ yq completion bash > /usr/local/etc/bash_completion.d/yq
Zsh: Zsh:
@ -29,16 +30,16 @@ Zsh:
$ echo "autoload -U compinit; compinit" >> ~/.zshrc $ echo "autoload -U compinit; compinit" >> ~/.zshrc
# To load completions for each session, execute once: # To load completions for each session, execute once:
$ yq shell-completion zsh > "${fpath[1]}/_yq" $ yq completion zsh > "${fpath[1]}/_yq"
# You will need to start a new shell for this setup to take effect. # You will need to start a new shell for this setup to take effect.
Fish: Fish:
$ yq shell-completion fish | source $ yq completion fish | source
# To load completions for each session, execute once: # To load completions for each session, execute once:
$ yq shell-completion fish > ~/.config/fish/completions/yq.fish $ yq completion fish > ~/.config/fish/completions/yq.fish
`, `,
DisableFlagsInUseLine: true, DisableFlagsInUseLine: true,
ValidArgs: []string{"bash", "zsh", "fish", "powershell"}, ValidArgs: []string{"bash", "zsh", "fish", "powershell"},