docker 的help系统

docker的命令的结构

docker command一般是分节呈现的，其结构是“docker 对象类型 command params”
比如，我们可以用“docker image ls”来列出当前机器上的image信息。

docker的对象类型

以下是docker中经常用到的对象类型：
image
container
volume
network

docker不同对象类型的通用命令

不同类型的对象类型可能会有不同的command， 但是以下这些command是通用的：
ls：列出所有此类对象
rm：删除某个此类对象
inspect：查看对象的详情
help：打印帮助信息

无对象类型的命令

但是也有一些命令不需要指定对象类型，有不少此类命令是对象类型命令的简化版本。
比如，
"docker ps" 是 "docker container ls" 的简化版。
"docker rm xxx" 是 "docker container rm xxx" 的简化版。
"docker irm xxx" 是 "docker image rm xxx" 的简化版。
"docker run xxx" 是 "docker container run xxx" 的简化版。
"docker exec xxx" 是 "docker container exec xxx" 的简化版。
"docker start xxx" 是 "docker container start xxx" 的简化版。
"docker stop xxx" 是 "docker container stop xxx" 的简化版。

docker的help系统

docker 命令和参数很多，我们不可能一一记住，因此docker为我们准备了不同级别的帮助系统。
比如，

最高级的help

“docker help”会打印出所有docker支持的命令和参数。

 

[me@localhost ~]$ docker help

Usage:  docker [OPTIONS] COMMAND

A self-sufficient runtime for containers

Options:
      --config string      Location of client config files (default "/home/yuke/.docker")
  -c, --context string     Name of the context to use to connect to the daemon (overrides DOCKER_HOST env var and default
                           context set with "docker context use")
  -D, --debug              Enable debug mode
  -H, --host list          Daemon socket(s) to connect to
  -l, --log-level string   Set the logging level ("debug"|"info"|"warn"|"error"|"fatal") (default "info")
      --tls                Use TLS; implied by --tlsverify
      --tlscacert string   Trust certs signed only by this CA (default "/home/yuke/.docker/ca.pem")
      --tlscert string     Path to TLS certificate file (default "/home/yuke/.docker/cert.pem")
      --tlskey string      Path to TLS key file (default "/home/yuke/.docker/key.pem")
      --tlsverify          Use TLS and verify the remote
  -v, --version            Print version information and quit

Management Commands:
  builder     Manage builds
  config      Manage Docker configs
  container   Manage containers
  context     Manage contexts
  engine      Manage the docker engine
  image       Manage images
  network     Manage networks
  node        Manage Swarm nodes
  plugin      Manage plugins
  secret      Manage Docker secrets
  service     Manage services
  stack       Manage Docker stacks
  swarm       Manage Swarm
  system      Manage Docker
  trust       Manage trust on Docker images
  volume      Manage volumes

Commands:
  attach      Attach local standard input, output, and error streams to a running container
  build       Build an image from a Dockerfile
  commit      Create a new image from a container's changes
  cp          Copy files/folders between a container and the local filesystem
  create      Create a new container
  diff        Inspect changes to files or directories on a container's filesystem
  events      Get real time events from the server
  exec        Run a command in a running container
  export      Export a container's filesystem as a tar archive
  history     Show the history of an image
  images      List images
  import      Import the contents from a tarball to create a filesystem image
  info        Display system-wide information
  inspect     Return low-level information on Docker objects
  kill        Kill one or more running containers
  load        Load an image from a tar archive or STDIN
  login       Log in to a Docker registry
  logout      Log out from a Docker registry
  logs        Fetch the logs of a container
  pause       Pause all processes within one or more containers
  port        List port mappings or a specific mapping for the container
  ps          List containers
  pull        Pull an image or a repository from a registry
  push        Push an image or a repository to a registry
  rename      Rename a container
  restart     Restart one or more containers
  rm          Remove one or more containers
  rmi         Remove one or more images
  run         Run a command in a new container
  save        Save one or more images to a tar archive (streamed to STDOUT by default)
  search      Search the Docker Hub for images
  start       Start one or more stopped containers
  stats       Display a live stream of container(s) resource usage statistics
  stop        Stop one or more running containers
  tag         Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE
  top         Display the running processes of a container
  unpause     Unpause all processes within one or more containers
  update      Update configuration of one or more containers
  version     Show the Docker version information
  wait        Block until one or more containers stop, then print their exit codes

对象类型级的help

“docker image help”会打印出所有image对象类型支持的命令和参数。

[me@localhost ~]$ docker image help

Usage:  docker image COMMAND

Manage images

Commands:
  build       Build an image from a Dockerfile
  history     Show the history of an image
  import      Import the contents from a tarball to create a filesystem image
  inspect     Display detailed information on one or more images
  load        Load an image from a tar archive or STDIN
  ls          List images
  prune       Remove unused images
  pull        Pull an image or a repository from a registry
  push        Push an image or a repository to a registry
  rm          Remove one or more images
  save        Save one or more images to a tar archive (streamed to STDOUT by default)
  tag         Create a tag TARGET_IMAGE that refers to SOURCE_IMAGE 

命令级的help

“docker image history -h”会打印出所有image对象类型history命令所支持的参数。

  

[me@localhost ~]$ docker image history -h
Flag shorthand -h has been deprecated, please use --help

Usage:  docker image history [OPTIONS] IMAGE

Show the history of an image

Options:
      --format string   Pretty-print images using a Go template
  -H, --human           Print sizes and dates in human readable format (default true)
      --no-trunc        Don't truncate output
  -q, --quiet           Only show numeric IDs