The Docker CLI
Go to file
Sebastiaan van Stijn 2d88c896bc
cli: print full command as aliases in usage output
The default output for Cobra aliases only shows the subcommand as alias, which
is not very intuitive. This patch changes the output to print the full command
as it would be called by the user.

Note that there's still some improvements to be made; due to how aliases must be
set-up in Cobra, aliases at different "levels" are still not shown. So for example,
`docker ps --help` will not show `docker container ps` as alias, and vice-versa.
This will require additional changes, and can possibly be resolved using custom
metadata/annotations.

Before this patch:

    docker container ls --help

    Usage:  docker container ls [OPTIONS]

    List containers

    Aliases:
      ls, ps, list

After this patch:

    docker container ls --help

    Usage:  docker container ls [OPTIONS]

    List containers

    Aliases:
      docker container ls, docker container ps, docker container list

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2022-06-28 11:03:30 +02:00
.circleci dummy circleci config 2022-02-25 21:15:39 +01:00
.github update golang to 1.18.3 2022-06-02 09:22:18 +02:00
cli cli: print full command as aliases in usage output 2022-06-28 11:03:30 +02:00
cli-plugins Adopt Cobra completion v2 to support completion by CLI plugins 2022-05-12 12:59:10 +02:00
cmd/docker Adopt Cobra completion v2 to support completion by CLI plugins 2022-05-12 12:59:10 +02:00
contrib/completion completion: remove options related to deprecated cluster-store 2022-05-17 11:03:25 +02:00
dockerfiles bake: use no-cache-filter for outdated stage 2022-06-05 16:25:05 +02:00
docs Improve doc code formatting 2022-06-21 23:13:23 -07:00
e2e cli: print full command as aliases in usage output 2022-06-28 11:03:30 +02:00
experimental experimental: fix broken link to "checkpoint and restore" page 2021-09-07 13:30:48 +02:00
internal/test Fix psFormat's Size handling in config file 2022-06-07 12:48:56 +02:00
man docs: remove documentation about deprecated cluster-store 2022-05-17 11:00:51 +02:00
opts gofmt with go1.17 2022-03-26 20:21:00 +01:00
scripts Makefile: don't warn "outside container" for some targets 2022-04-06 19:10:53 +02:00
service/logs bump gotest.tools v3.0.1 for compatibility with Go 1.14 2020-02-23 00:28:55 +01:00
templates staticcheck: ignore SA1019: strings.Title is deprecated 2022-03-28 17:23:06 +02:00
vendor vendor: github.com/docker/docker 38633e797195643580ce5c4af7c5422aad3eb7de 2022-06-03 19:34:27 +02:00
.dockerignore validate manpages target 2022-02-25 17:11:17 +01:00
.gitattributes fix linguist with .gitattributes 2021-12-16 21:16:02 +01:00
.gitignore validate manpages target 2022-02-25 17:11:17 +01:00
.golangci.yml lint: update golangci-lint to v1.45.2 2022-03-28 10:37:27 +02:00
.mailmap update AUTHORS and mailmap 2022-06-03 12:18:51 +02:00
AUTHORS update AUTHORS and mailmap 2022-06-03 12:18:51 +02:00
CONTRIBUTING.md Fix broken link in CONTRIBUTING 2020-03-19 15:03:59 +01:00
Dockerfile Dockerfile: update xx to 1.1.1 2022-06-05 16:16:16 +02:00
LICENSE Add project files 2017-04-17 17:49:33 -04:00
MAINTAINERS Add Djordje Lukic to maintainers 2022-04-19 10:44:12 +02:00
Makefile Makefile: don't warn "outside container" for some targets 2022-04-06 19:10:53 +02:00
NOTICE switch kr/pty to creack/pty v1.1.7 2019-07-29 16:45:41 -07:00
README.md remove circleci 2022-02-25 17:11:17 +01:00
TESTING.md tweak description of login/logout 2022-04-04 10:44:11 +02:00
VERSION Update version to 22.06.0-dev 2022-05-17 11:41:40 +02:00
codecov.yml Drop support for (archived) Compose-on-Kubernetes 2022-02-22 13:47:34 +01:00
docker-bake.hcl bake: align platforms 2022-06-06 18:33:17 +02:00
docker.Makefile Makefile: add missing help messages for some targets 2022-04-06 18:34:51 +02:00
vendor.mod vendor: github.com/docker/docker 38633e797195643580ce5c4af7c5422aad3eb7de 2022-06-03 19:34:27 +02:00
vendor.sum vendor: github.com/docker/docker 38633e797195643580ce5c4af7c5422aad3eb7de 2022-06-03 19:34:27 +02:00

README.md

Docker CLI

PkgGoDev Build Status Test Status Go Report Card Codecov

About

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

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, 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.