Run Commands

Pachctl Auto-completion

Learn how to install our auto-completion helper tool (it's great for learning PachCTL commands).

Pachyderm autocompletion allows you to automatically finish partially typed commands by pressing TAB. Autocompletion needs to be installed separately when pachctl is already available on your client machine.

Pachyderm autocompletion is supported for bash and zsh shells. You must have either of them preinstalled before installing Pachyderm autocompletion.

💡

Type pachctl completion --help to display help information about the command.

Command Shell:
  1. Verify that zsh-completions are installed on your machine. For example, if you have installed zsh completion by using Homebrew, type:

    brew info zsh-completions

    You should see the directory in which zsh-completions are installed and instructions to add the correct path in the ~/.zshrc file. Make sure you add the required path. If you do not have the ~/.zshrc file on your computer, create one. For more information about setting up zsh completions, see zsh-completions.

  2. Install pachctl autocompletion for zsh:

    pachctl completion zsh --install --path <path/to/zsh-completions>

    Example:

    pachctl completion zsh --install --path /usr/local/share/zsh-completions/_pachctl

    System response:

    Completions installed in "_pachctl", you must restart your terminal to enable them.
  3. Restart your terminal.

    pachctl autocomplete should now be enabled in your system.