README

build status Build Status

docker/cli

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 a linux binary:

$ make -f docker.Makefile binary

Build binaries for all supported platforms:

$ make -f docker.Makefile cross

Run all linting:

$ make -f docker.Makefile lint

List all the available targets:

$ make help
In-container development environment

Start an interactive development environment:

$ make -f docker.Makefile shell

In the development environment you can run many tasks, including build binaries:

$ make binary

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.

Expand ▾ Collapse ▴

Directories

Path Synopsis
cli
connhelper
Package connhelper provides helpers for connecting to a remote daemon host with custom logic.
Package connhelper provides helpers for connecting to a remote daemon host with custom logic.
connhelper/ssh
Package ssh provides the connection helper for ssh:// URL.
Package ssh provides the connection helper for ssh:// URL.
winresources
Package winresources is used to embed Windows resources into docker.exe.
Package winresources is used to embed Windows resources into docker.exe.
cmd
docs
e2e
compose
Package compose is the internal version of the API.
Package compose is the internal version of the API.
compose/v1beta1
Package v1beta1 is the first version of the Stack spec, containing only a compose file
Package v1beta1 is the first version of the Stack spec, containing only a compose file
compose/v1beta2
Package v1beta2 is the second version of the stack, containing a structured spec
Package v1beta2 is the second version of the stack, containing a structured spec
service
logs
Package logs contains tools for parsing docker log lines.
Package logs contains tools for parsing docker log lines.
internal
test
Package test is a test-only package that can be used by other cli package to write unit test.
Package test is a test-only package that can be used by other cli package to write unit test.
test/builders
Package builders helps you create struct for your unit test while keeping them expressive.
Package builders helps you create struct for your unit test while keeping them expressive.