Command-line completion

Estimated reading time: 1 minute

Docker Machine comes with command completion for the bash and zsh shell.

Installing Command Completion

Bash

Make sure bash completion is installed. If you are using a current version of Linux in a non-minimal installation, bash completion should be available.

On a Mac, install with brew install bash-completion.

Place the completion script in /etc/bash_completion.d/ as follows:

  • On a Mac:

    curl -L https://raw.githubusercontent.com/docker/docker-ce/master/components/cli/contrib/completion/bash/docker > `brew --prefix`/etc/bash_completion.d/docker
    
  • On a standard Linux installation:

    curl -L https://raw.githubusercontent.com/docker/docker-ce/master/components/cli/contrib/completion/bash/docker > /etc/bash_completion.d/docker
    

Completion will be available upon next login.

Zsh

Place the completion script in your /path/to/zsh/completion, using e.g. ~/.zsh/completion/:

mkdir -p ~/.zsh/completion
curl -L https://raw.githubusercontent.com/docker/machine/master/contrib/completion/zsh/_docker-machine > ~/.zsh/completion/_docker-machine

Include the directory in your $fpath, e.g. by adding in ~/.zshrc:

fpath=(~/.zsh/completion $fpath)

Make sure compinit is loaded or do it by adding in ~/.zshrc:

autoload -Uz compinit && compinit -i

Then reload your shell:

exec $SHELL -l

Available completions

Depending on what you typed on the command line so far, it will complete:

  • commands and their options
  • container IDs and names
  • image repositories and image tags
  • file paths

Where to go next

machine, docker, orchestration, cli, reference