diff --git a/content/config/formatting.md b/content/config/formatting.md index 2f1230f00e..ca95c8d1d7 100644 --- a/content/config/formatting.md +++ b/content/config/formatting.md @@ -3,36 +3,32 @@ description: CLI and log output formatting reference keywords: format, formatting, output, templates, log title: Format command and log output aliases: -- /engine/admin/formatting/ + - /engine/admin/formatting/ --- -Docker uses [Go templates](https://golang.org/pkg/text/template/) which you can -use to manipulate the output format of certain commands and log drivers. +Docker supports [Go templates](https://golang.org/pkg/text/template/) which you +can use to manipulate the output format of certain commands and log drivers. Docker provides a set of basic functions to manipulate template elements. All of these examples use the `docker inspect` command, but many other CLI commands have a `--format` flag, and many of the CLI command references include examples of customizing the output format. ->**Note** +> **Note** > -> When using the `--format` flag, you need observe your shell environment. -> In a Posix shell, you can run the following with a single quote: +> When using the `--format` flag, you need observe your shell environment. +> In a POSIX shell, you can run the following with a single quote: > -> > ```console > $ docker inspect --format '{{join .Args " , "}}' > ``` -> > > Otherwise, in a Windows shell (for example, PowerShell), you need to use single quotes, but -> escape the double quotes inside the params as follows: +> escape the double quotes inside the parameters as follows: > -> > ```console > $ docker inspect --format '{{join .Args \" , \"}}' > ``` -> > { .important } @@ -41,89 +37,70 @@ include examples of customizing the output format. `join` concatenates a list of strings to create a single string. It puts a separator between each element in the list. - ```console $ docker inspect --format '{{join .Args " , "}}' container ``` - ## table `table` specifies which fields you want to see its output. - ```console $ docker image list --format "table {{.ID}}\t{{.Repository}}\t{{.Tag}}\t{{.Size}}" ``` - ## json `json` encodes an element as a json string. - - ```console $ docker inspect --format '{{json .Mounts}}' container ``` - ## lower `lower` transforms a string into its lowercase representation. - ```console $ docker inspect --format "{{lower .Name}}" container ``` - ## split `split` slices a string into a list of strings separated by a separator. - ```console $ docker inspect --format '{{split .Image ":"}}' container ``` - ## title `title` capitalizes the first character of a string. - ```console $ docker inspect --format "{{title .Name}}" container ``` - ## upper `upper` transforms a string into its uppercase representation. - ```console $ docker inspect --format "{{upper .Name}}" container ``` - - ## println `println` prints each value on a new line. - ```console $ docker inspect --format='{{range .NetworkSettings.Networks}}{{println .IPAddress}}{{end}}' container ``` - # Hint To find out what data can be printed, show all content as json: - ```console $ docker container ls --format='{{json .}}' -``` \ No newline at end of file +```