The Docker CLI
Go to file
Sebastiaan van Stijn bca2090061
cli: make cli.StatusError slightly prettier
This error didn't do a great job at formatting. If a StatusError was
produced without a Status message, it would print a very non-informative
error, with information missing.

Let's update the output:

- If a status-message is provided; print just that (after all the
  status code is something that can be found from the shell, e.g.
  through `echo $?` in Bash).
- If no status-message is provided: print a message more similar to
  Go's `exec.ExecError`, which uses `os.rocessState.String()` (see [1]).

Before this patch, an error without custom status would print:

    Status: , Code: 2

After this patch:

    exit status 2

In situations where a custom error-message is provided, the error-message
is print as-is, whereas before this patch, the message got combined with
the `Status:` and `Code:`, which resulted in some odd output.

Before this patch:

    docker volume --no-such-flag
    Status: unknown flag: --no-such-flag
    See 'docker volume --help'.

    Usage:  docker volume COMMAND

    Manage volumes

    Commands:
      create      Create a volume
      inspect     Display detailed information on one or more volumes
      ls          List volumes
      prune       Remove unused local volumes
      rm          Remove one or more volumes
      update      Update a volume (cluster volumes only)

    Run 'docker volume COMMAND --help' for more information on a command.
    , Code: 125

With this patch, the error is shown as-is;

    docker volume --no-such-flag
    unknown flag: --no-such-flag
    See 'docker volume --help'.

    Usage:  docker volume COMMAND

    Manage volumes

    Commands:
      create      Create a volume
      inspect     Display detailed information on one or more volumes
      ls          List volumes
      prune       Remove unused local volumes
      rm          Remove one or more volumes
      update      Update a volume (cluster volumes only)

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

While the exit-code is no longer printed, it's still properly handled;

    echo $?
    125

[1]: 82c14346d8/src/os/exec_posix.go (L107-L135)

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2024-07-04 22:08:18 +02:00
.github Merge pull request #5216 from Benehiko/force-lf 2024-07-04 02:09:34 +02:00
cli cli: make cli.StatusError slightly prettier 2024-07-04 22:08:18 +02:00
cli-plugins cli: make initializing the global meter- and tracing providers optional 2024-06-24 15:44:20 +02:00
cmd/docker cli: make initializing the global meter- and tracing providers optional 2024-06-24 15:44:20 +02:00
contrib/completion Removed all mentions of "please" from docs and messages 2024-06-11 16:53:40 +02:00
dockerfiles update to go1.21.12 2024-07-03 10:59:37 +02:00
docs docs: make buildx build the canonical reference doc 2024-07-03 08:55:16 +02:00
e2e update to go1.21.12 2024-07-03 10:59:37 +02:00
experimental deprecate experimental graphdriver plugins 2024-06-18 16:47:00 +02:00
hack/otel OTEL collector/prometheus/aspire-dashboard stack for testing purposes 2024-04-30 12:25:19 +00:00
internal/test replace uses of deprecated API types 2024-07-04 15:22:18 +02:00
man Additional typo corrections 2024-06-20 12:18:43 +02:00
opts test spring-cleaning 2024-07-04 01:35:12 +02:00
scripts update go-md2man to v2.0.4 2024-06-18 21:47:47 +02:00
service/logs service/logs: use strings.Cut 2022-12-29 15:19:31 +01:00
templates Update go:build comments to go1.21 2024-06-18 12:17:13 +02:00
vendor vendor: github.com/docker/docker 508cc7c61226 (master) 2024-07-04 15:20:27 +02:00
.dockerignore validate manpages target 2022-02-25 17:11:17 +01:00
.gitattributes feat: force lf line endings by default 2024-07-02 11:53:42 +02:00
.gitignore Removed all mentions of "please" from docs and messages 2024-06-11 16:53:40 +02:00
.golangci.yml update golangci-lint to .v1.59.0 2024-06-10 21:19:32 +02:00
.mailmap update mailmap and AUTHORS 2024-06-20 13:22:11 +02:00
AUTHORS update mailmap and AUTHORS 2024-06-20 13:22:11 +02:00
CONTRIBUTING.md Removed all mentions of "please" from docs and messages 2024-06-11 16:53:40 +02:00
Dockerfile update to go1.21.12 2024-07-03 10:59:37 +02:00
LICENSE Add project files 2017-04-17 17:49:33 -04:00
MAINTAINERS not actually a maintainer 2023-11-10 21:35:15 +01:00
Makefile Dockerfile: update mvdan/gofumpt to v0.6.0 2024-03-17 13:48:13 +01:00
NOTICE Removed all mentions of "please" from docs and messages 2024-06-11 16:53:40 +02:00
README.md Removed all mentions of "please" from docs and messages 2024-06-11 16:53:40 +02:00
TESTING.md tweak description of login/logout 2022-04-04 10:44:11 +02:00
VERSION bump version to v27.0.1-dev 2024-06-18 13:29:00 +02:00
codecov.yml Drop support for (archived) Compose-on-Kubernetes 2022-02-22 13:47:34 +01:00
docker-bake.hcl update to go1.21.12 2024-07-03 10:59:37 +02:00
docker.Makefile Cleanup of dockerfiles, compose files and env vars 2024-02-13 13:32:45 +00:00
vendor.mod vendor: github.com/docker/docker 508cc7c61226 (master) 2024-07-04 15:20:27 +02:00
vendor.sum vendor: github.com/docker/docker 508cc7c61226 (master) 2024-07-04 15:20:27 +02:00

README.md

Docker CLI

PkgGoDev Build Status Test Status Go Report Card Codecov

About

This repository is the home of the Docker CLI.

Development

docker/cli is developed using Docker.

Build CLI from source:

docker buildx bake

Build binaries for all supported platforms:

docker buildx bake cross

Build for a specific platform:

docker buildx bake --set binary.platform=linux/arm64 

Build dynamic binary for glibc or musl:

USE_GLIBC=1 docker buildx bake dynbinary 

Run all linting:

docker buildx bake lint shellcheck

Run test:

docker buildx bake test

List all the available targets:

make help

In-container development environment

Start an interactive development environment:

make -f docker.Makefile shell

Brought to you courtesy of our legal counsel. For more context, 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, 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.