From 4dee681848af5973c9d678ac762f51982186f4f2 Mon Sep 17 00:00:00 2001 From: Boaz Shuster Date: Sun, 5 Mar 2017 20:02:03 +0200 Subject: [PATCH] Add format to docker stack ls Signed-off-by: Boaz Shuster Upstream-commit: 5be9e57c519706e48b33f3291da1c0e0f51947c8 Component: cli --- .../docs/reference/commandline/stack_ls.md | 27 ++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/components/cli/docs/reference/commandline/stack_ls.md b/components/cli/docs/reference/commandline/stack_ls.md index 567d947bab..91349b6947 100644 --- a/components/cli/docs/reference/commandline/stack_ls.md +++ b/components/cli/docs/reference/commandline/stack_ls.md @@ -24,7 +24,8 @@ Aliases: ls, list Options: - --help Print usage + --help Print usage + --format string Pretty-print stacks using a Go template ``` ## Description @@ -43,6 +44,30 @@ vossibility-stack 6 myapp 2 ``` +### Formatting + +The formatting option (`--format`) pretty-prints stacks using a Go template. + +Valid placeholders for the Go template are listed below: + +| Placeholder | Description | +| ----------- | ------------------ | +| `.Name` | Stack name | +| `.Services` | Number of services | + +When using the `--format` option, the `stack ls` command either outputs +the data exactly as the template declares or, when using the +`table` directive, includes column headers as well. + +The following example uses a template without headers and outputs the +`Name` and `Services` entries separated by a colon for all stacks: + +```bash +$ docker stack ls --format "{{.Name}}: {{.Services}}" +web-server: 1 +web-cache: 4 +``` + ## Related commands * [stack deploy](stack_deploy.md)