Guest24897
/
DockerCLI
mirror of https://github.com/docker/cli.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
The Docker CLI
9,945 Commits 11 Branches 241 Tags 240 MiB
Go 91.3%
Shell 5.8%
Go-Checksums 1.3%
Dockerfile 1.1%
Makefile 0.3%
Other 0.2%
Go to file
Sebastiaan van Stijn 90058df305
cli/command/container: remove reportError, and put StatusError to use 
The `reportError` utility was present because cli.StatusError would print
the error decorated with `Status: <error-message>, Code: <exit-code>`.
That was not desirable in many cases as it would mess-up the output. To
prevent this, the CLI had code to check for an empty `Status` (error message)
in which case the error would be "ignored" (and only used for the exit-status),
and the `reportError` utility would be used to manually print a custom error
message before returning the error.

Now that bca2090061 fixed the output format
of `cli.StatusError`, and 3dd6fc365d and
350a0b68a9 no longer discard these error,
we can get rid of this utility, and just set the error-message for
the status-error.

This patch:

- Introduces a `withHelp` which takes care of decorating errors with
  a "Run --help" hint for the user.
- Introduces a `toStatusError` utility that detects certain errors in
  the container to assign a corresponding exit-code (these error-codes
  can be used to distinguish "client" errors from "container" errors).
- Removes the `reportError` utility, and removes code that manually
  printed errors before returning.

Behavior is mostly unmodified, with the exception of some slight reformatting
of the errors:

- `withHelp` adds a `docker:` prefix to the error, to indicate the error
  is produced by the `docker` command. This prefix was already present
  in most cases.
- The "--help" hint is slightly updated ("Run 'docker run --help' for
  more information" instead of "See 'docker run --help'"), to make it
  more clear that it's a "call to action".
- An empty is added before the "--help" hint to separate it better from
  the error-message.

Before this patch:

    $ docker run --pull=invalid-option alpine
    docker: invalid pull option: 'invalid-option': must be one of "always", "missing" or "never".
    See 'docker run --help'.
    $ echo $?
    125

    $ docker run --rm alpine nosuchcommand
    docker: Error response from daemon: failed to create task for container: failed to create shim task: OCI runtime create failed: runc create failed: unable to start container process: exec: "nosuchcommand": executable file not found in $PATH: unknown.
    $ echo $?
    127

With this patch:

    $ docker run --pull=invalid-option alpine
    docker: invalid pull option: 'invalid-option': must be one of "always", "missing" or "never"

    Run 'docker run --help' for more information
    $ echo $?
    125

    $ docker run --rm alpine nosuchcommand
    docker: Error response from daemon: failed to create task for container: failed to create shim task: OCI runtime create failed: runc create failed: unable to start container process: exec: "nosuchcommand": executable file not found in $PATH: unknown.

    Run 'docker run --help' for more information
    $ echo $?
    127

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
 		2024-07-17 15:59:30 +02:00
.github Merge pull request #5216 from Benehiko/force-lf 2024-07-04 02:09:34 +02:00
cli cli/command/container: remove reportError, and put StatusError to use 2024-07-17 15:59:30 +02:00
cli-plugins Merge pull request #5234 from thaJeztah/nicer_missing_commands 2024-07-17 01:22:03 +02:00
cmd/docker cmd/docker: fix completion for --context 2024-07-17 01:25:33 +02:00
contrib/completion Removed all mentions of "please" from docs and messages 2024-06-11 16:53:40 +02:00
dockerfiles Dockerfile.dev: install bash-completion in dev container 2024-07-05 15:23:06 +02:00
docs docs: fix typos and version for cli-docs-tool scripts 2024-07-17 15:25:37 +02:00
e2e cli: FlagErrorFunc: don't print long usage output for invalid flags 2024-07-17 13:22:31 +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 docs: fix typos and version for cli-docs-tool scripts 2024-07-17 15:25:37 +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/cli-docs-tool v0.8.0 2024-07-17 15:23:23 +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 Makefile: add completion target 2024-07-08 10:58:56 -05: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/cli-docs-tool v0.8.0 2024-07-17 15:23:23 +02:00
vendor.sum vendor: github.com/docker/cli-docs-tool v0.8.0 2024-07-17 15:23:23 +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

Legal

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.