github.com/pachyderm/pachyderm@v1.13.4/doc/docs/1.11.x/getting_started/install-pachctl-completion.md (about)

     1  # Install `pachctl` Autocompletion
     2  
     3  Pachyderm autocompletion allows you to automatically finish
     4  partially typed commands by pressing `TAB`. Autocompletion needs
     5  to be installed separately when `pachctl` is already
     6  available on your client machine.
     7  
     8  Pachyderm autocompletion is supported for `bash` and `zsh` shells.
     9  You must have either of them preinstalled
    10  before installing Pachyderm autocompletion.
    11  
    12  !!! tip
    13      Type `pachctl completion --help` to display help information about
    14      the command.
    15  
    16  ## Install `pachctl` Autocompletion for `bash`
    17  
    18  If you are using bash as your preferred shell, follow the steps in this
    19  section to install `pachctl` completion for bash.
    20  
    21  To install `pachctl` autocompletion for `bash`, perform the following steps:
    22  
    23  1. Verify that `bash-completion` is installed on your machine.
    24     For example, if you have installed bash completion by using Homebrew,
    25     type:
    26  
    27     ```shell
    28     brew info bash-completion
    29     ```
    30  
    31     This command returns information about the directory in which
    32     `bash-completion` and bash completion scripts are installed.
    33     For example,  `/usr/local/etc/bash_completion.d/`. You need
    34     to specify the path to `bash_completion.d` as the path to which install
    35     `pachctl` autocompletion. Also, the output of the info
    36     command might have a suggestion to include the path to
    37     `bash-completion` into your `~/.bash_profile` file.
    38  
    39  1. Install `pachctl` autocompletion:
    40  
    41  
    42     ```shell
    43  
    44     pachctl completion bash --install --path <path/to/bash-completion>
    45     ```
    46  
    47     For example, if you specify the path to `bash-completion` as
    48     `/usr/local/etc/bash_completion.d/pachctl`, your system response
    49     looks like this:
    50  
    51     **System response:**
    52  
    53     ```
    54     Bash completions installed in /usr/local/etc/bash_completion.d/pachctl, you must restart bash to enable completions.
    55     ```
    56  
    57  1. Restart your terminal.
    58  
    59     `pachctl` autocomplete should now be enabled in your system.
    60  
    61  ## Install pachctl Autocompletion for `zsh`
    62  
    63  Recently, `zsh` became the default shell on macOS, therefore, many users
    64  might prefer using `zsh`. Before you install `pachctl` completion for `zsh`,
    65  you must have `zsh-completions` installed.
    66  
    67  To install `pachctl` completion for `zsh`, complete the following
    68  steps:
    69  
    70  1. Verify that `zsh-completions` are installed on your machine.
    71     For example, if you have installed zsh completion by using Homebrew,
    72     type:
    73  
    74     ```zsh
    75     brew info zsh-completions
    76     ```
    77  
    78     You should see the directory in which `zsh-completions` are installed
    79     and instructions to add the correct path in the `~/.zshrc` file. Make sure
    80     you add the required path. If you do not have the `~/.zshrc` file on
    81     your computer, create one. For more information about setting up zsh
    82     completions, see
    83     [zsh-completions](https://github.com/zsh-users/zsh-completions).
    84  
    85  1. Install `pachctl` autocompletion for `zsh`:
    86  
    87     ```zsh
    88     pachctl completion zsh --install --path <path/to/zfs-completions>
    89     ```
    90  
    91     **Example:**
    92  
    93     ```zsh
    94     pachctl completion zsh --install --path /usr/local/share/zsh-completions/_pachctl
    95     ```
    96  
    97     **System response:**
    98  
    99     ```
   100     Completions installed in "_pachctl", you must restart your terminal to enable them.
   101     ```
   102  
   103  1. Restart your terminal.
   104  
   105     `pachctl` autocomplete should now be enabled in your system.
   106  
   107  !!! note "See Also:"
   108  
   109      [Pachyderm Shell](../../deploy-manage/manage/pachctl_shell/)