shell autocomplete functions (#107)

* bash, zsh, fish autocomplete

* linux install

Author: matkam

.gitignore

@@ -16,3 +16,5 @@
 bin/
 .idea/
 dist/
+
+.DS_Store

.goreleaser.yaml

@@ -24,6 +24,7 @@ archives:
       darwin: mac
     files:
       - LICENSE
+      - 'autocomplete/*'
 release:
   github:
     owner: livekit

Makefile

@@ -18,3 +18,6 @@ check_lfs:
 		exit 1; \
 	fi \
 	}
+
+fish_autocomplete: cli
+	./bin/livekit-cli generate-fish-completion -o autocomplete/fish_autocomplete

autocomplete/bash_autocomplete

@@ -0,0 +1,21 @@
+#! /bin/bash
+
+# livekit-cli autocomplete for bash
+# original: https://github.com/urfave/cli/blob/main/autocomplete/bash_autocomplete
+
+_cli_bash_autocomplete() {
+  if [[ "${COMP_WORDS[0]}" != "source" ]]; then
+    local cur opts base
+    COMPREPLY=()
+    cur="${COMP_WORDS[COMP_CWORD]}"
+    if [[ "$cur" == "-"* ]]; then
+      opts=$( ${COMP_WORDS[@]:0:$COMP_CWORD} ${cur} --generate-bash-completion )
+    else
+      opts=$( ${COMP_WORDS[@]:0:$COMP_CWORD} --generate-bash-completion )
+    fi
+    COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
+    return 0
+  fi
+}
+
+complete -o bashdefault -o default -o nospace -F _cli_bash_autocomplete livekit-cli

autocomplete/fish_autocomplete

@@ -0,0 +1,21 @@
+# livekit-cli autocomplete for zsh
+# original: https://github.com/urfave/cli/blob/main/autocomplete/zsh_autocomplete
+
+_cli_zsh_autocomplete() {
+  local -a opts
+  local cur
+  cur=${words[-1]}
+  if [[ "$cur" == "-"* ]]; then
+    opts=("${(@f)$(${words[@]:0:#words[@]-1} ${cur} --generate-bash-completion)}")
+  else
+    opts=("${(@f)$(${words[@]:0:#words[@]-1} --generate-bash-completion)}")
+  fi
+
+  if [[ "${opts[1]}" != "" ]]; then
+    _describe 'values' opts
+  else
+    _files
+  fi
+}
+
+compdef _cli_zsh_autocomplete livekit-cli

autocomplete/zsh_autocomplete

@@ -14,14 +14,29 @@ import (
 
 func main() {
 	app := &cli.App{
-		Name:  "livekit-cli",
-		Usage: "CLI client to LiveKit",
+		Name:                 "livekit-cli",
+		Usage:                "CLI client to LiveKit",
+		Version:              livekitcli.Version,
+		EnableBashCompletion: true,
+		Suggest:              true,
 		Flags: []cli.Flag{
 			&cli.BoolFlag{
 				Name: "verbose",
 			},
 		},
-		Version: livekitcli.Version,
+		Commands: []*cli.Command{
+			{
+				Name:   "generate-fish-completion",
+				Action: generateFishCompletion,
+				Hidden: true,
+				Flags: []cli.Flag{
+					&cli.StringFlag{
+						Name:    "out",
+						Aliases: []string{"o"},
+					},
+				},
+			},
+		},
 	}
 
 	logger.SetLogger(stdr.New(log.Default()), "livekit-cli")
@@ -38,3 +53,21 @@ func main() {
 		fmt.Println(err)
 	}
 }
+
+func generateFishCompletion(c *cli.Context) error {
+	fishScript, err := c.App.ToFishCompletion()
+	if err != nil {
+		return err
+	}
+
+	outPath := c.String("out")
+	if outPath != "" {
+		if err := os.WriteFile(outPath, []byte(fishScript), 0o644); err != nil {
+			return err
+		}
+	} else {
+		fmt.Println(fishScript)
+	}
+
+	return nil
+}

cmd/livekit-cli/main.go

@@ -8,6 +8,9 @@ set -o pipefail
 
 REPO="livekit-cli"
 INSTALL_PATH="/usr/local/bin"
+BASH_COMPLETION_PATH="/usr/share/bash-completion/completions"
+ZSH_COMPLETION_PATH="/usr/share/zsh/site-functions"
+FISH_COMPLETION_PATH="/usr/share/fish/vendor_completions.d"
 
 log()  { printf "%b\n" "$*"; }
 abort() {
@@ -82,6 +85,28 @@ fi
 log "Installing ${REPO} ${VERSION}"
 log "Downloading from ${ARCHIVE_URL}..."
 
-curl -s -L "${ARCHIVE_URL}" | ${SUDO_PREFIX} tar xzf - -C "${INSTALL_PATH}" --wildcards --no-anchored "$REPO*"
+TEMP_DIR_PATH="$(mktemp -d)"
+
+curl -s -L "${ARCHIVE_URL}" | ${SUDO_PREFIX} tar xzf - -C "${TEMP_DIR_PATH}" --wildcards --no-anchored "$REPO*"
+
+mv "${TEMP_DIR_PATH}/livekit-cli" "${INSTALL_PATH}/livekit-cli"
+
+if [ -d "${TEMP_DIR_PATH}/autocomplete" ]
+then
+  if [ -d "${BASH_COMPLETION_PATH}" ]
+  then
+    mv "${TEMP_DIR_PATH}/autocomplete/bash_autocomplete" "${BASH_COMPLETION_PATH}/livekit-cli"
+  fi
+
+  if [ -d "${ZSH_COMPLETION_PATH}" ]
+  then
+    mv "${TEMP_DIR_PATH}/autocomplete/zsh_autocomplete" "${BASH_COMPLETION_PATH}/_livekit-cli"
+  fi
+
+  if [ -d "${FISH_COMPLETION_PATH}" ]
+  then
+    livekit-cli generate-fish-completion -o "${FISH_COMPLETION_PATH}/livekit-cli.fish"
+  fi
+fi
 
 log "\n$REPO is installed to $INSTALL_PATH\n"