The Docker CLI
Go to file
Sebastiaan van Stijn 4c25f6ce95
implement treewriter
Nothing mergeable here, but this was me playing around; initially to see
if we could print the format such as suggested in https://github.com/docker/cli/issues/5560#issuecomment-2437212303

That output is shown in `TestTree`:

    IMAGE/TAGS ID                                    DISK USAGE          CONTENT SIZE        USED
    alpine:latest                                    beefdbd8a1da        13.6MB              4.09MB
    ├─ linux/amd64                                   33735bd63cf8        0B                  0B
    ├─ linux/arm/v6                                  50f635c8b04d        0B                  0B
    ├─ linux/arm/v7                                  f2f82d424957        0B                  0B
    ├─ linux/arm64/v8                                9cee2b382fe2        13.6MB              4.09MB
    ├─ linux/386                                     b3e87f642f5c        0B                  0B
    ├─ linux/ppc64le                                 c7a6800e3dc5        0B                  0B
    ├─ linux/riscv64                                 80cde017a105        0B                  0B
    └─ linux/s390x                                   2b5b26e09ca2        0B                  0B

    namespace/image                                  beefdbd8a1da        13.6MB              4.09MB
    ├─ namespace/image:1                             beefdbd8a1da        -                   -
    ├─ namespace/image:1.0                           beefdbd8a1da        -                   -
    ├─ namespace/image:1.0.0                         beefdbd8a1da        -                   -
    └─ namespace/image:latest                        beefdbd8a1da        -                   -
       ├─ linux/amd64                                33735bd63cf8        0B                  0B
       ├─ linux/arm/v6                               50f635c8b04d        0B                  0B
       ├─ linux/arm/v7                               f2f82d424957        0B                  0B
       ├─ linux/arm64/v8                             9cee2b382fe2        13.6MB              4.09MB
       ├─ linux/386                                  b3e87f642f5c        0B                  0B
       ├─ linux/ppc64le                              c7a6800e3dc5        0B                  0B
       ├─ linux/riscv64                              80cde017a105        0B                  0B
       └─ linux/s390x                                2b5b26e09ca2        0B                  0B

    internal.example.com/namespace/image             beefdbd8a1da        13.6MB              4.09MB
    ├─ internal.example.com/namespace/image:1        beefdbd8a1da        -                   -
    ├─ internal.example.com/namespace/image:1.0      beefdbd8a1da        -                   -
    ├─ internal.example.com/namespace/image:1.0.0    beefdbd8a1da        -                   -
    └─ internal.example.com/namespace/image:latest   beefdbd8a1da        -                   -
       ├─ linux/amd64                                33735bd63cf8        0B                  0B
       ├─ linux/arm/v6                               50f635c8b04d        0B                  0B
       ├─ linux/arm/v7                               f2f82d424957        0B                  0B
       ├─ linux/arm64/v8                             9cee2b382fe2        13.6MB              4.09MB
       ├─ linux/386                                  b3e87f642f5c        0B                  0B
       ├─ linux/ppc64le                              c7a6800e3dc5        0B                  0B
       ├─ linux/riscv64                              80cde017a105        0B                  0B
       └─ linux/s390x                                2b5b26e09ca2        0B                  0B

And `TestTreeNoTrunc` (non-truncated):

    IMAGE/TAGS ID                                    DISK USAGE                                                                CONTENT SIZE        USED
    alpine:latest                                    sha256:beefdbd8a1da6d2915566fde36db9db0b524eb737fc57cd1367effd16dc0d06d   13.6MB              4.09MB
    ├─ linux/amd64                                   sha256:33735bd63cf84d7e388d9f6d297d348c523c044410f553bd878c6d7829612735   0B                  0B
    ├─ linux/arm/v6                                  sha256:50f635c8b04d86dde8a02bcd8d667ba287eb8b318c1c0cf547e5a48ddadea1be   0B                  0B
    ├─ linux/arm/v7                                  sha256:f2f82d42495723c4dc508fd6b0978a5d7fe4efcca4282e7aae5e00bcf4057086   0B                  0B
    ├─ linux/arm64/v8                                sha256:9cee2b382fe2412cd77d5d437d15a93da8de373813621f2e4d406e3df0cf0e7c   13.6MB              4.09MB
    ├─ linux/386                                     sha256:b3e87f642f5c48cdc7556c3e03a0d63916bd0055ba6edba7773df3cb1a76f224   0B                  0B
    ├─ linux/ppc64le                                 sha256:c7a6800e3dc569a2d6e90627a2988f2a7339e6f111cdf6a0054ad1ff833e99b0   0B                  0B
    ├─ linux/riscv64                                 sha256:80cde017a10529a18a7274f70c687bb07c4969980ddfb35a1b921fda3a020e5b   0B                  0B
    └─ linux/s390x                                   sha256:2b5b26e09ca2856f50ac88312348d26c1ac4b8af1df9f580e5cf465fd76e3d4d   0B                  0B

    namespace/image                                  sha256:beefdbd8a1da6d2915566fde36db9db0b524eb737fc57cd1367effd16dc0d06d   13.6MB              4.09MB
    ├─ namespace/image:1                             sha256:beefdbd8a1da6d2915566fde36db9db0b524eb737fc57cd1367effd16dc0d06d   -                   -
    ├─ namespace/image:1.0                           sha256:beefdbd8a1da6d2915566fde36db9db0b524eb737fc57cd1367effd16dc0d06d   -                   -
    ├─ namespace/image:1.0.0                         sha256:beefdbd8a1da6d2915566fde36db9db0b524eb737fc57cd1367effd16dc0d06d   -                   -
    └─ namespace/image:latest                        sha256:beefdbd8a1da6d2915566fde36db9db0b524eb737fc57cd1367effd16dc0d06d   -                   -
       ├─ linux/amd64                                sha256:33735bd63cf84d7e388d9f6d297d348c523c044410f553bd878c6d7829612735   0B                  0B
       ├─ linux/arm/v6                               sha256:50f635c8b04d86dde8a02bcd8d667ba287eb8b318c1c0cf547e5a48ddadea1be   0B                  0B
       ├─ linux/arm/v7                               sha256:f2f82d42495723c4dc508fd6b0978a5d7fe4efcca4282e7aae5e00bcf4057086   0B                  0B
       ├─ linux/arm64/v8                             sha256:9cee2b382fe2412cd77d5d437d15a93da8de373813621f2e4d406e3df0cf0e7c   13.6MB              4.09MB
       ├─ linux/386                                  sha256:b3e87f642f5c48cdc7556c3e03a0d63916bd0055ba6edba7773df3cb1a76f224   0B                  0B
       ├─ linux/ppc64le                              sha256:c7a6800e3dc569a2d6e90627a2988f2a7339e6f111cdf6a0054ad1ff833e99b0   0B                  0B
       ├─ linux/riscv64                              sha256:80cde017a10529a18a7274f70c687bb07c4969980ddfb35a1b921fda3a020e5b   0B                  0B
       └─ linux/s390x                                sha256:2b5b26e09ca2856f50ac88312348d26c1ac4b8af1df9f580e5cf465fd76e3d4d   0B                  0B

    internal.example.com/namespace/image             sha256:beefdbd8a1da6d2915566fde36db9db0b524eb737fc57cd1367effd16dc0d06d   13.6MB              4.09MB
    ├─ internal.example.com/namespace/image:1        sha256:beefdbd8a1da6d2915566fde36db9db0b524eb737fc57cd1367effd16dc0d06d   -                   -
    ├─ internal.example.com/namespace/image:1.0      sha256:beefdbd8a1da6d2915566fde36db9db0b524eb737fc57cd1367effd16dc0d06d   -                   -
    ├─ internal.example.com/namespace/image:1.0.0    sha256:beefdbd8a1da6d2915566fde36db9db0b524eb737fc57cd1367effd16dc0d06d   -                   -
    └─ internal.example.com/namespace/image:latest   sha256:beefdbd8a1da6d2915566fde36db9db0b524eb737fc57cd1367effd16dc0d06d   -                   -
       ├─ linux/amd64                                sha256:33735bd63cf84d7e388d9f6d297d348c523c044410f553bd878c6d7829612735   0B                  0B
       ├─ linux/arm/v6                               sha256:50f635c8b04d86dde8a02bcd8d667ba287eb8b318c1c0cf547e5a48ddadea1be   0B                  0B
       ├─ linux/arm/v7                               sha256:f2f82d42495723c4dc508fd6b0978a5d7fe4efcca4282e7aae5e00bcf4057086   0B                  0B
       ├─ linux/arm64/v8                             sha256:9cee2b382fe2412cd77d5d437d15a93da8de373813621f2e4d406e3df0cf0e7c   13.6MB              4.09MB
       ├─ linux/386                                  sha256:b3e87f642f5c48cdc7556c3e03a0d63916bd0055ba6edba7773df3cb1a76f224   0B                  0B
       ├─ linux/ppc64le                              sha256:c7a6800e3dc569a2d6e90627a2988f2a7339e6f111cdf6a0054ad1ff833e99b0   0B                  0B
       ├─ linux/riscv64                              sha256:80cde017a10529a18a7274f70c687bb07c4969980ddfb35a1b921fda3a020e5b   0B                  0B
       └─ linux/s390x                                sha256:2b5b26e09ca2856f50ac88312348d26c1ac4b8af1df9f580e5cf465fd76e3d4d   0B                  0B

The above is all without the nice color-formatting etc, but this would be handled
before this;

The second bit was to see if we could make the tree output more align
with other output formats;

- Most of our commands allow passing a `--format`, including for (e.g.) `table`
- We want the tree view to also support, e.g. `--no-trunc`, which means that
  some columns will be wider.
- If we use a tabwriter for printing, we can have it handle the column-sizing
  for us.
- And if we do, we could let the user pass a custom format, and still print
  it as a tree.

e.g., a format could be;

    --format 'tree {.Image}}\t{{.Digest}}\t{{.InUse}}'

Which would output something like

    IMAGE                   ID             USED
    alpine:latest           beefdbd8a1da    ✔
    ├─ linux/amd64          33735bd63cf8
    ├─ linux/arm/v6         50f635c8b04d
    ├─ linux/arm/v7         f2f82d424957
    ├─ linux/arm64/v8       9cee2b382fe2    ✔
    ├─ linux/386            b3e87f642f5c
    ├─ linux/ppc64le        c7a6800e3dc5
    ├─ linux/riscv64        80cde017a105
    └─ linux/s390x          2b5b26e09ca2

The `TestTree` implementation is really quirky though, as it uses a `[][]string`,
which won't work well if we want to make it more generic (with an "unknown"
depth); probably needs some type defined that has an optional slice for child
rows; those child-rows can be pre-formatted.

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2024-10-28 13:56:38 +01:00
.github ci: update to go1.22.8 2024-10-04 20:20:16 +00:00
cli implement treewriter 2024-10-28 13:56:38 +01:00
cli-plugins plugins: don't panic on Close if PluginServer nil 2024-08-07 14:04:31 +01:00
cmd/docker cmd/docker: add tests for flag-completions, and refactor 2024-10-18 11:23:55 +02:00
contrib/completion Fix bash completion for `events --filter daemon=` 2024-10-19 15:40:07 +00:00
dockerfiles ci: update to go1.22.8 2024-10-04 20:20:16 +00:00
docs docker inspect: add support for swarm configs 2024-10-24 18:32:32 +02:00
e2e ci: update to go1.22.8 2024-10-04 20:20:16 +00: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 vendor: github.com/docker/docker 36a3bd090489 (master, v28.0-dev) 2024-10-18 17:48:05 +02:00
opts move parsing key-value files to a separate package 2024-10-04 12:27:10 +02:00
pkg/kvfile move parsing key-value files to a separate package 2024-10-04 12:27:10 +02:00
scripts vendor: github.com/docker/docker 36a3bd090489 (master, v28.0-dev) 2024-10-18 17:48:05 +02:00
service/logs service/logs: use strings.Cut 2022-12-29 15:19:31 +01:00
templates templates: add test for HeaderFunctions 2024-10-18 10:07:33 +02:00
vendor vendor: github.com/docker/docker 36a3bd090489 (master, v28.0-dev) 2024-10-18 17:48:05 +02:00
.dockerignore validate manpages target 2022-02-25 17:11:17 +01:00
.gitattributes fix: binary file line endings 2024-09-06 10:23:23 +02:00
.gitignore Removed all mentions of "please" from docs and messages 2024-06-11 16:53:40 +02:00
.golangci.yml chore: remove duplicated `govet` linter config 2024-09-11 17:55:43 +08: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 Fix broken links in CONTRIBUTING.md 2024-09-08 23:08:14 +05:30
Dockerfile ci: update to go1.22.8 2024-10-04 20:20:16 +00: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 README: update pkg.go.dev badge, add OpenSSF scorecard 2024-10-12 22:12:38 +02:00
SECURITY.md add security policy 2024-08-05 11:58:34 +02:00
TESTING.md tweak description of login/logout 2022-04-04 10:44:11 +02:00
VERSION Update `VERSION` file to `v27.3.1-dev` 2024-09-20 11:41:30 +01:00
codecov.yml Drop support for (archived) Compose-on-Kubernetes 2022-02-22 13:47:34 +01:00
docker-bake.hcl ci: update to go1.22.8 2024-10-04 20:20:16 +00: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 36a3bd090489 (master, v28.0-dev) 2024-10-18 17:48:05 +02:00
vendor.sum vendor: github.com/docker/docker 36a3bd090489 (master, v28.0-dev) 2024-10-18 17:48:05 +02:00

README.md

Docker CLI

PkgGoDev Build Status Test Status Go Report Card OpenSSF Scorecard 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.