From 30bf35c2c23fa9da85b73007652a88804874a3d6 Mon Sep 17 00:00:00 2001 From: Richard Date: Sun, 5 Oct 2025 15:48:24 -0300 Subject: [PATCH 1/4] Update README.md Signed-off-by: Richard --- README.md | 91 ++++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 83 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 351ce40ffbfd..5b90ff0f5c7b 100644 --- a/README.md +++ b/README.md @@ -7,51 +7,111 @@ [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/docker/cli/badge)](https://scorecard.dev/viewer/?uri=github.com/docker/cli) [![Codecov](https://img.shields.io/codecov/c/github/docker/cli?logo=codecov)](https://codecov.io/gh/docker/cli) +image + +--- + +# Table of Contents + +- [About](#about) +- [Features](#features) +- [Development](#development) + - [Build CLI from Source](#build-cli-from-source) + - [Build Binaries for All supported Platforms](#build-binaries-for-all-supported-platforms) + - [Build for a Specific Platform](#build-for-a-specific-platform) + - [Build Dynamic Binary for glibc or musl](#build-dynamic-binary-for-glibc-or-musl) + - [Run all Linting](#run-all-linting) + - [Run Test](#run-test) + - [List all the Available Targets](#list-all-the-available-targets) + - [In-container Development Environment](#in-container-development-environment) +- [Legal](#legal) +- [Community](#community) +- [Licensing](#licensing) + + +--- + ## About -This repository is the home of the Docker CLI. +The Docker CLI is the official command-line interface used to interact with the Docker Engine. It provides developers, DevOps engineers, and system administrators with a powerful tool to manage containerized applications and resources such as images, containers, networks, and volumes. + +This CLI is a key component of the Docker platform and is widely used in development environments, CI/CD pipelines, and production systems across various operating systems and architectures. + +This repository contains the source code and tooling required to build, test, and contribute to the Docker CLI. It supports cross-compilation, custom builds, and offers a developer-friendly workflow using Docker itself. + +## Features + +Some of the key features of the Docker CLI include: + +- 🐳 **Container Lifecycle Management** + Create, start, stop, restart, and remove containers with simple commands. + +- πŸ“¦ **Image Management** + Build, pull, push, and inspect Docker images across local and remote registries. + +- πŸ”„ **Multi-Platform Builds** + Cross-compile and build images for multiple platforms using `buildx`. + +- βš™οΈ **Network and Volume Control** + Manage container networking, custom bridge networks, and persistent storage volumes. + +- πŸ” **Inspect and Debug** + Use commands like `docker inspect`, `logs`, and `exec` to investigate running containers. + +- πŸ§ͺ **Scriptable and CI/CD Friendly** + Seamless integration with CI/CD tools for automated testing, building, and deployment. + +- πŸ“š **Extensive Documentation and Plugin Support** + Well-documented CLI commands and support for extensions and custom plugins. + +- 🐳 **Docker Contexts** + Easily switch between different Docker endpoints (e.g., local, remote, cloud). + +- πŸ” **Secure by Design** + Actively maintained with security in mind and part of the OpenSSF Scorecard program. + ## Development `docker/cli` is developed using Docker. -Build CLI from source: +### Build CLI from source: ```shell docker buildx bake ``` -Build binaries for all supported platforms: +### Build binaries for all supported platforms: ```shell docker buildx bake cross ``` -Build for a specific platform: +### Build for a specific platform: ```shell docker buildx bake --set binary.platform=linux/arm64 ``` -Build dynamic binary for glibc or musl: +### Build dynamic binary for glibc or musl: ```shell USE_GLIBC=1 docker buildx bake dynbinary ``` -Run all linting: +### Run all linting: ```shell docker buildx bake lint shellcheck ``` -Run test: +### Run test: ```shell docker buildx bake test ``` -List all the available targets: +### List all the available targets: ```shell make help @@ -78,6 +138,21 @@ violate applicable laws. For more information, see https://www.bis.doc.gov +## Community + +We welcome contributions, feedback, and collaboration from the community! + +### Where to connect + +- [GitHub Discussions](https://github.com/docker/cli/discussions) – Ask questions, share ideas, or get help. +- [Contributing Guide](https://github.com/docker/cli/blob/master/CONTRIBUTING.md) – Learn how to contribute to the Docker CLI. +- [Docker Community Forums](https://forums.docker.com) – Join conversations with the broader Docker community. +- [Docker Community Slack](https://dockr.ly/slack) – Chat with other developers in real time. +- [Issues](https://github.com/docker/cli/issues) – Found a bug? Report it here. +- [Code of Conduct](https://github.com/docker/cli/blob/master/CODE_OF_CONDUCT.md) + +We’re excited to see what you’ll build and contribute with Docker CLI! + ## Licensing docker/cli is licensed under the Apache License, Version 2.0. See From 82dfe7993486f4161577c624552c71f686bd817c Mon Sep 17 00:00:00 2001 From: Richard Date: Sun, 5 Oct 2025 15:52:31 -0300 Subject: [PATCH 2/4] Update README.md Signed-off-by: Richard --- README.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 5b90ff0f5c7b..3a1c09e9cb04 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/docker/cli/badge)](https://scorecard.dev/viewer/?uri=github.com/docker/cli) [![Codecov](https://img.shields.io/codecov/c/github/docker/cli?logo=codecov)](https://codecov.io/gh/docker/cli) -image +docker-logo-blue --- @@ -43,31 +43,31 @@ This repository contains the source code and tooling required to build, test, an Some of the key features of the Docker CLI include: -- 🐳 **Container Lifecycle Management** +- **Container Lifecycle Management** Create, start, stop, restart, and remove containers with simple commands. -- πŸ“¦ **Image Management** +- **Image Management** Build, pull, push, and inspect Docker images across local and remote registries. -- πŸ”„ **Multi-Platform Builds** +- **Multi-Platform Builds** Cross-compile and build images for multiple platforms using `buildx`. -- βš™οΈ **Network and Volume Control** +- **Network and Volume Control** Manage container networking, custom bridge networks, and persistent storage volumes. -- πŸ” **Inspect and Debug** +- **Inspect and Debug** Use commands like `docker inspect`, `logs`, and `exec` to investigate running containers. -- πŸ§ͺ **Scriptable and CI/CD Friendly** +- **Scriptable and CI/CD Friendly** Seamless integration with CI/CD tools for automated testing, building, and deployment. -- πŸ“š **Extensive Documentation and Plugin Support** +- **Extensive Documentation and Plugin Support** Well-documented CLI commands and support for extensions and custom plugins. -- 🐳 **Docker Contexts** +- **Docker Contexts** Easily switch between different Docker endpoints (e.g., local, remote, cloud). -- πŸ” **Secure by Design** +- **Secure by Design** Actively maintained with security in mind and part of the OpenSSF Scorecard program. @@ -149,7 +149,6 @@ We welcome contributions, feedback, and collaboration from the community! - [Docker Community Forums](https://forums.docker.com) – Join conversations with the broader Docker community. - [Docker Community Slack](https://dockr.ly/slack) – Chat with other developers in real time. - [Issues](https://github.com/docker/cli/issues) – Found a bug? Report it here. -- [Code of Conduct](https://github.com/docker/cli/blob/master/CODE_OF_CONDUCT.md) We’re excited to see what you’ll build and contribute with Docker CLI! From 5a816be052c37609c93c248f2a1653dad503914d Mon Sep 17 00:00:00 2001 From: Richard Date: Sun, 5 Oct 2025 15:53:47 -0300 Subject: [PATCH 3/4] Update README.md Signed-off-by: Richard --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3a1c09e9cb04..7ff361d1a06d 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ --- -# Table of Contents +# πŸ“Œ Table of Contents - [About](#about) - [Features](#features) From c15b1222b016b7db41ce54e474362dc3076b3fef Mon Sep 17 00:00:00 2001 From: Richard Date: Sun, 5 Oct 2025 15:57:42 -0300 Subject: [PATCH 4/4] Update README.md Signed-off-by: Richard --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7ff361d1a06d..5ea6324fed89 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ [![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/docker/cli/badge)](https://scorecard.dev/viewer/?uri=github.com/docker/cli) [![Codecov](https://img.shields.io/codecov/c/github/docker/cli?logo=codecov)](https://codecov.io/gh/docker/cli) -docker-logo-blue +docker-logo ---