The Docker CLI
Go to file
Sebastiaan van Stijn ab92626619 Improve usage output for docker run
Commit a77f2450c70312f8c26877a18bfe2baa44d4abb9 switched `docker run`
to use the `pflags` package. Due to this change, the usage output for
the `--blkio-weight-device` and `--device-*` flags changed and now
showed `weighted-device`, and `throttled-device` as value type. As a
result, the output of `docker run --help` became a lot wider.

This patch changes the output to show `list` instead, which is
consistent with other options that allow to be set multiple times.

Output before this change;

    Usage:	docker run [OPTIONS] IMAGE [COMMAND] [ARG...]

    Run a command in a new container

    Options:
          --blkio-weight uint16                   Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0)
          --blkio-weight-device weighted-device   Block IO weight (relative device weight) (default [])
          --device list                           Add a host device to the container (default [])
          --device-read-bps throttled-device      Limit read rate (bytes per second) from a device (default [])
          --device-read-iops throttled-device     Limit read rate (IO per second) from a device (default [])
          --device-write-bps throttled-device     Limit write rate (bytes per second) to a device (default [])
          --device-write-iops throttled-device    Limit write rate (IO per second) to a device (default [])
      -w, --workdir string                        Working directory inside the container

Output after this change;

    Usage:	docker run [OPTIONS] IMAGE [COMMAND] [ARG...]

    Run a command in a new container

    Options:
          --blkio-weight uint16         Block IO (relative weight), between 10 and 1000, or 0 to disable (default 0)
          --blkio-weight-device list    Block IO weight (relative device weight) (default [])
          --device list                 Add a host device to the container (default [])
          --device-read-bps list        Limit read rate (bytes per second) from a device (default [])
          --device-read-iops list       Limit read rate (IO per second) from a device (default [])
          --device-write-bps list       Limit write rate (bytes per second) to a device (default [])
          --device-write-iops list      Limit write rate (IO per second) to a device (default [])
      -w, --workdir string              Working directory inside the container

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2017-05-15 11:57:20 +02:00
.github Add github templates and initial poule configuration 2017-05-09 16:57:46 +02:00
cli Merge pull request #44 from cyli/root-ca-info-in-cli 2017-05-12 17:19:23 -07:00
cmd/docker Display proper version information 2017-05-09 14:22:51 -07:00
dockerfiles Add check for compose bindata. 2017-05-09 15:42:22 -04:00
opts Improve usage output for docker run 2017-05-15 11:57:20 +02:00
script/validate Add check for compose bindata. 2017-05-09 15:42:22 -04:00
scripts/build Display proper version information 2017-05-09 14:22:51 -07:00
vendor Vendor docker/docker 2017-05-11 13:42:46 -07:00
.dockerignore make go build and docker build operations faster 2017-04-27 15:06:57 -07:00
.gitignore make go build and docker build operations faster 2017-04-27 15:06:57 -07:00
LICENSE Add project files 2017-04-17 17:49:33 -04:00
MAINTAINERS Add project files 2017-04-17 17:49:33 -04:00
Makefile Merge pull request #56 from dnephin/add-compose-bindata-check 2017-05-10 15:49:06 -04:00
NOTICE Add project files 2017-04-17 17:49:33 -04:00
README.md rm client and vendor it instead 2017-05-08 10:33:56 -07:00
circle.yml Add check for compose bindata. 2017-05-09 15:42:22 -04:00
docker.Makefile Fix typo in docker.Makefile 2017-05-11 02:02:13 -07:00
gometalinter.json Add line length linter 2017-05-08 15:57:56 -04:00
poule.yml Add github templates and initial poule configuration 2017-05-09 16:57:46 +02:00
vendor.conf Vendor docker/docker 2017-05-11 13:42:46 -07:00

README.md

build status

docker/cli

This repository is the home of the cli used in the Docker CE and Docker EE products.

It's composed of 3 main folders

  • /cli - all the commands code.
  • /cmd/docker - the entrypoint of the cli, aka the main.

Development

Build locally

$ make build
$ make clean

You will need gox for this one:

$ make cross

If you don't have gox, you can use the "in-container" version of make cross, listed below.

Build inside container

$ make -f docker.Makefile build
$ make -f docker.Makefile clean
$ make -f docker.Makefile cross

In-container development environment

$ make -f docker.Makefile dev

Then you can use the build locally commands:

$ make build
$ make clean

Legal

Brought to you courtesy of our legal counsel. For more context, please see the NOTICE document in this repo.

Use and transfer of Docker may be subject to certain restrictions by the United States and other governments.

It is your responsibility to ensure that your use and/or transfer does not violate applicable laws.

For more information, please see https://www.bis.doc.gov

Licensing

docker/cli is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.