socket install / uninstall

Install or uninstall Socket CLI tab completion

$ socket install --help

  Install Socket CLI tab completion

  Usage
    $ socket install <command>

  Commands
    completion                  Install bash completion for Socket CLI

  Options

    --no-banner                 Hide the Socket banner
    --no-spinner                Hide the console spinner

socket install completion and socket uninstall completion set up and remove tab completion for the Socket CLI. Tab completion only works in bash. socket login also offers to set it up for you.

socket install completion

$ socket install completion --help

  Install bash completion for Socket CLI

  Usage
    $ socket install completion [options] [NAME=socket]

  Installs bash completion for the Socket CLI. This will:
  1. Source the completion script in your current shell
  2. Add the source command to your ~/.bashrc if it's not already there

  This command will only setup tab completion, nothing else.

  Afterwards you should be able to type `socket ` and then press tab to
  have bash auto-complete/suggest the sub/command or flags.

  Currently only supports bash.

  The optional name argument allows you to enable tab completion on a command
  name other than "socket". Mostly for debugging but also useful if you use a
  different alias for socket on your system.

  Options
    (none)

  Examples

    $ socket install completion
    $ socket install completion sd
    $ socket install completion ./sd

The command copies the completion script into a socket/completion folder next to the CLI config, for example ~/.local/share/socket/completion/socket-completion.bash on Linux. It then adds a block to ~/.bashrc that loads the script. If you have no ~/.bashrc, the script is copied but nothing loads it.

Your current shell doesn't pick up the change. Run source ~/.bashrc or open a new terminal.

socket uninstall completion

$ socket uninstall completion --help

  Uninstall bash completion for Socket CLI

  Usage
    $ socket uninstall completion [options] [COMMAND_NAME=socket]

  Uninstalls bash tab completion for the Socket CLI. This will:
  1. Remove tab completion from your current shell for given command
  2. Remove the setup for given command from your ~/.bashrc

  The optional name is required if you installed tab completion for an alias
  other than the default "socket". This will NOT remove the command, only the
  tab completion that is registered for it in bash.

  Options
    (none)

  Examples

    $ socket uninstall completion
    $ socket uninstall completion sd

The command removes the Socket block from ~/.bashrc. To drop completion from your current shell right away, run complete -r socket, or use the name you installed it for.


Did this page help you?