Skip to content

Commit

Permalink
Merge pull request #11 from symbiosis-cloud/feature/autocomplete
Browse files Browse the repository at this point in the history
added autocomplete command
  • Loading branch information
thecodeassassin authored Feb 7, 2023
2 parents 143ede4 + aece6e2 commit 07227a1
Show file tree
Hide file tree
Showing 3 changed files with 134 additions and 0 deletions.
43 changes: 43 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,3 +56,46 @@ Currently the CLI is in Beta. We only expose a limited number of CLI commands cu
* Describe node pool
* List node pools

## Autocomplete

To load completions:

### Bash
```
$ source <(sym completion bash)
# To load completions for each session, execute once:
# Linux:
$ sym completion bash > /etc/bash_completion.d/sym
# macOS:
$ sym completion bash > $(brew --prefix)/etc/bash_completion.d/sym
```
### Zsh (Linux / macOS)
```
# If shell completion is not already enabled in your environment,
# you will need to enable it. You can execute the following once:
$ echo "autoload -U compinit; compinit" >> ~/.zshrc
# To load completions for each session, execute once:
$ sym completion zsh > "${fpath[1]}/_sym"
# You will need to start a new shell for this setup to take effect.
```
### fish:
```
$ sym completion fish | source
# To load completions for each session, execute once:
$ sym completion fish > ~/.config/fish/completions/sym.fish
```
### PowerShell
```
PS> sym completion powershell | Out-String | Invoke-Expression
# To load completions for every new session, run:
PS> sym completion powershell > sym.ps1
# and source this file from your PowerShell profile.
```
90 changes: 90 additions & 0 deletions commands/completion.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
/*
Copyright © 2022 Symbiosis
*/
package commands

import (
"fmt"
"os"

"github.com/spf13/cobra"
"github.com/symbiosis-cloud/cli/pkg/symcommand"
"github.com/symbiosis-cloud/symbiosis-go"
)

type CompletionCommand struct {
Client *symbiosis.Client
CommandOpts *symcommand.CommandOpts
}

func (c *CompletionCommand) Execute(command *cobra.Command, args []string) {
switch args[0] {
case "bash":
command.Root().GenBashCompletion(os.Stdout)
case "zsh":
command.Root().GenZshCompletion(os.Stdout)
case "fish":
command.Root().GenFishCompletion(os.Stdout, true)
case "powershell":
command.Root().GenPowerShellCompletionWithDesc(os.Stdout)
}

}

func (c *CompletionCommand) Command() *cobra.Command {

cmd := &cobra.Command{
Use: "completion [bash|zsh|fish|powershell]",
Short: "Generate completion script",
Long: fmt.Sprintf(`To load completions:
Bash:
$ source <(%[1]s completion bash)
# To load completions for each session, execute once:
# Linux:
$ %[1]s completion bash > /etc/bash_completion.d/%[1]s
# macOS:
$ %[1]s completion bash > $(brew --prefix)/etc/bash_completion.d/%[1]s
Zsh:
# If shell completion is not already enabled in your environment,
# you will need to enable it. You can execute the following once:
$ echo "autoload -U compinit; compinit" >> ~/.zshrc
# To load completions for each session, execute once:
$ %[1]s completion zsh > "${fpath[1]}/_%[1]s"
# You will need to start a new shell for this setup to take effect.
fish:
$ %[1]s completion fish | source
# To load completions for each session, execute once:
$ %[1]s completion fish > ~/.config/fish/completions/%[1]s.fish
PowerShell:
PS> %[1]s completion powershell | Out-String | Invoke-Expression
# To load completions for every new session, run:
PS> %[1]s completion powershell > %[1]s.ps1
# and source this file from your PowerShell profile.
`, "sym"),
DisableFlagsInUseLine: true,
ValidArgs: []string{"bash", "zsh", "fish", "powershell"},
Args: cobra.MatchAll(cobra.ExactArgs(1), cobra.OnlyValidArgs),
Run: c.Execute,
}

return cmd
}

func (c *CompletionCommand) Init(client *symbiosis.Client, opts *symcommand.CommandOpts) {
c.Client = client
c.CommandOpts = opts
}
1 change: 1 addition & 0 deletions commands/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ func init() {
&ApiKeysCommand{},
&VersionCommand{},
&TestCommand{},
&CompletionCommand{},
}

// TODO: find a way to toggle beta commands via a flag
Expand Down

0 comments on commit 07227a1

Please sign in to comment.