2016-10-14 22:30:36 +00:00
|
|
|
---
|
|
|
|
title: "stack ls"
|
|
|
|
description: "The stack ls command description and usage"
|
2016-11-03 22:48:30 +00:00
|
|
|
keywords: "stack, ls"
|
2016-10-14 22:30:36 +00:00
|
|
|
---
|
2016-06-23 05:00:21 +00:00
|
|
|
|
2016-10-19 17:25:45 +00:00
|
|
|
<!-- This file is maintained within the docker/docker Github
|
|
|
|
repository at https://github.com/docker/docker/. Make all
|
|
|
|
pull requests against that repo. If you see this file in
|
|
|
|
another repository, consider it read-only there, as it will
|
|
|
|
periodically be overwritten by the definitive file. Pull
|
|
|
|
requests which include edits to this file in other repositories
|
|
|
|
will be rejected.
|
|
|
|
-->
|
|
|
|
|
2016-11-23 10:14:38 +00:00
|
|
|
# stack ls
|
2016-06-23 05:00:21 +00:00
|
|
|
|
|
|
|
```markdown
|
|
|
|
Usage: docker stack ls
|
|
|
|
|
|
|
|
List stacks
|
2016-11-27 12:38:49 +00:00
|
|
|
|
|
|
|
Aliases:
|
|
|
|
ls, list
|
|
|
|
|
|
|
|
Options:
|
2017-03-05 18:02:03 +00:00
|
|
|
--help Print usage
|
|
|
|
--format string Pretty-print stacks using a Go template
|
2016-06-23 05:00:21 +00:00
|
|
|
```
|
|
|
|
|
2017-01-28 00:47:41 +00:00
|
|
|
## Description
|
2017-02-07 23:42:48 +00:00
|
|
|
|
2016-06-23 05:00:21 +00:00
|
|
|
Lists the stacks.
|
|
|
|
|
2017-02-07 23:42:48 +00:00
|
|
|
## Examples
|
|
|
|
|
|
|
|
The following command shows all stacks and some additional information:
|
2016-06-23 05:00:21 +00:00
|
|
|
|
|
|
|
```bash
|
|
|
|
$ docker stack ls
|
|
|
|
|
|
|
|
ID SERVICES
|
|
|
|
vossibility-stack 6
|
|
|
|
myapp 2
|
|
|
|
```
|
|
|
|
|
2017-03-05 18:02:03 +00:00
|
|
|
### 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
|
|
|
|
```
|
|
|
|
|
2017-02-07 23:42:48 +00:00
|
|
|
## Related commands
|
2016-06-23 05:00:21 +00:00
|
|
|
|
|
|
|
* [stack deploy](stack_deploy.md)
|
2016-10-13 19:03:08 +00:00
|
|
|
* [stack ps](stack_ps.md)
|
2016-12-13 10:06:18 +00:00
|
|
|
* [stack rm](stack_rm.md)
|
2016-11-02 09:46:02 +00:00
|
|
|
* [stack services](stack_services.md)
|