【Docker】コマンド一覧から仕様確認

Dockerに限らず、PC上で動くコマンド（CUI:Character User Interface）は、frontendの機能（GUI:Graphical User Interface）を実装することで、画面上でクリックするとdocker runが走り、コンテナが起動するDocker Desktopや、Web上のアカウントへloginすることで、自身のアカウントと連携し、ローカルへDockerSNS上のimageからpullしてきたりなど、GUIを操作することで、CUIを実行していることがままある（と思います。）

それらのGUI（Graphical User Interface）での操作を行い、CUI(Character User Interface)で実行することで、dockerというアプリケーションの全体像が把握できるかと思います。

上記の観点で、仕様把握を行うにあたり、CUI:Character User Interface の全リストを確認し、使用するコマンド・機能だけでも把握しておくことで、dockerの全容を掴みやすくなるのではないか、といった記事となります。

そこで、コマンド一覧を下記の流れで把握していきたいと思います。

docker --help
docker COMMAND --help
docker container --help
docker container COMMAND --help
docker container attach --help

まずは

docker --help

を行い、出力された下記を何となく一読します。

Usage:  docker [OPTIONS] COMMAND

A self-sufficient runtime for containers

Common Commands:
  run         Create and run a new container from an image
  exec        Execute a command in a running container
  ps          List containers
  build       Build an image from a Dockerfile
  pull        Download an image from a registry
  push        Upload an image to a registry
  images      List images
  login       Log in to a registry
  logout      Log out from a registry
  search      Search Docker Hub for images
  version     Show the Docker version information
  info        Display system-wide information

Management Commands:
  builder     Manage builds
  buildx*     Docker Buildx (Docker Inc., v0.11.2-desktop.5)
  compose*    Docker Compose (Docker Inc., v2.23.0-desktop.1)
  container   Manage containers
  context     Manage contexts
  dev*        Docker Dev Environments (Docker Inc., v0.1.0)
  extension*  Manages Docker extensions (Docker Inc., v0.2.20)
  image       Manage images
  init*       Creates Docker-related starter files for your project (Docker Inc., v0.1.0-beta.9)
  manifest    Manage Docker image manifests and manifest lists
  network     Manage networks
  plugin      Manage plugins
  sbom*       View the packaged-based Software Bill Of Materials (SBOM) for an image (Anchore Inc., 0.6.0)
  scan*       Docker Scan (Docker Inc., v0.26.0)
  scout*      Docker Scout (Docker Inc., v1.0.9)
  system      Manage Docker
  trust       Manage trust on Docker images
  volume      Manage volumes

Swarm Commands:
  swarm       Manage Swarm

Commands:
  attach      Attach local standard input, output, and error streams to a running container
  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
  export      Export a container's filesystem as a tar archive
  history     Show the history of an image
  import      Import the contents from a tarball to create a filesystem image
  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
  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
  rename      Rename a container
  restart     Restart one or more containers
  rm          Remove one or more containers
  rmi         Remove one or more images
  save        Save one or more images to a tar archive (streamed to STDOUT by default)
  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
  wait        Block until one or more containers stop, then print their exit codes

Global Options:
      --config string      Location of client config files (default "/Users/fujitajunya/.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 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
                           "/Users/fujitajunya/.docker/ca.pem")
      --tlscert string     Path to TLS certificate file (default "/Users/fujitajunya/.docker/cert.pem")
      --tlskey string      Path to TLS key file (default "/Users/fujitajunya/.docker/key.pem")
      --tlsverify          Use TLS and verify the remote
  -v, --version            Print version information and quit

Run 'docker COMMAND --help' for more information on a command.

下記を確認しました。
Common Commands:　
実行したコマンドがいくつかあり、操作に対して機能が想像できる。loginから下は何となく機能が想像でき、docker hubのアカウントへログインする操作と被るなど、GUI（Graphical User Interface）での操作からCUI(Character User Interface)での機能を想像できる状態。
Management Commands:
Common Commandsが「動詞」のイメージに対し、Management Commandは「名詞」のイメージ。最後の方にある'docker COMMAND --help'を実行すると、上記の一覧がもう一度流れます。そこで、'COMMAND'には上記の'docker container --help'などで、知りたいコマンドの詳細が確認できると気づきました。仕様確認として、迷ったら'docker --help'で一覧を取得し、'docker container --help'や'docker run --help'などで、そのコマンドの詳細を確認できる、といった流れを確認しました。--helpがオプション化している理由も、container --helpで、'container help'となっている場合、走る機能が重複するため、オプション化していると想定できます。（合っているかは不明です・・）
Swarm Commands:
何を指しているか分からず、さっと流しました。
Commands:
attachとdiffを読み、その後cpに目を通し、between a container and the local filesystemから、diffではcontainerのみの変化を読み取り、cpは、containerとローカルの間のコピーのやりとりかな、とあたりをつけました。もちろん、コマンドを打ち込んで仕様確認がベストですが、ここでは一旦予想で留めます。（覚えきれないので・・）

まとめ

1 docker --help　で一覧取得
2 docker COMMAND --help　でCOMMANDに当てはめるコマンドを1から選択。
3 docker container --help　で1で表示されたコマンドの詳細を確認。
4 docker container COMMAND --help　2と同じように、さらなる詳細が確認可能。
5 docker container attach --help　3で表示されたコマンドの詳細を確認。

一覧と詳細のread機能を駆使して、自分の知りたいコマンドを適宜検索しましょう。（一生基礎練のフラグが・・）