2016-11-09 20:49:09 -05:00
# plugin ls
2016-06-09 17:57:15 -04:00
2023-01-06 13:04:05 -05:00
<!-- - MARKER_GEN_START -->
2016-07-07 14:43:18 -04:00
List plugins
2016-06-09 17:57:15 -04:00
2023-01-06 13:04:05 -05:00
### Aliases
`docker plugin ls` , `docker plugin list`
### Options
2023-01-13 10:22:26 -05:00
| Name | Type | Default | Description |
|:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`-f` ](#filter ), [`--filter` ](#filter ) | `filter` | | Provide filter values (e.g. `enabled=true` ) |
| [`--format` ](#format ) | `string` | | Format output using a custom template:< br > 'table': Print output in table format with column headers (default)< br > 'table TEMPLATE': Print output in table format using the given Go template< br > 'json': Print in JSON format< br > 'TEMPLATE': Print output using the given Go template.< br > Refer to https://docs.docker.com/go/formatting/ for more information about formatting output with templates |
2024-07-03 02:29:57 -04:00
| `--no-trunc` | `bool` | | Don't truncate output |
| `-q` , `--quiet` | `bool` | | Only display plugin IDs |
2023-01-06 13:04:05 -05:00
<!-- - MARKER_GEN_END -->
2016-06-09 17:57:15 -04:00
2017-02-07 18:42:48 -05:00
## Description
2016-06-09 17:57:15 -04:00
Lists all the plugins that are currently installed. You can install plugins
using the [`docker plugin install` ](plugin_install.md ) command.
2016-11-23 07:58:15 -05:00
You can also filter using the `-f` or `--filter` flag.
2023-01-06 12:05:02 -05:00
Refer to the [filtering ](#filter ) section for more information about available filter options.
2016-06-09 17:57:15 -04:00
2017-02-07 18:42:48 -05:00
## Examples
2016-06-09 17:57:15 -04:00
2021-08-21 08:54:14 -04:00
```console
2016-06-09 17:57:15 -04:00
$ docker plugin ls
2016-07-20 17:37:55 -04:00
2020-06-18 10:37:36 -04:00
ID NAME DESCRIPTION ENABLED
69553ca1d123 tiborvass/sample-volume-plugin:latest A test plugin for Docker true
2016-06-09 17:57:15 -04:00
```
2023-01-13 10:22:26 -05:00
### <a name="filter"></a> Filtering (--filter)
2016-11-23 07:58:15 -05:00
The filtering flag (`-f` or `--filter` ) format is of "key=value". If there is more
2023-12-13 18:06:16 -05:00
than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"` ).
2016-11-23 07:58:15 -05:00
The currently supported filters are:
* enabled (boolean - true or false, 0 or 1)
2017-04-13 21:56:50 -04:00
* capability (string - currently `volumedriver` , `networkdriver` , `ipamdriver` , `logdriver` , `metricscollector` , or `authz` )
2016-11-23 07:58:15 -05:00
2017-02-07 18:42:48 -05:00
#### enabled
2016-11-23 07:58:15 -05:00
The `enabled` filter matches on plugins enabled or disabled.
2017-02-07 18:42:48 -05:00
#### capability
2016-11-23 08:27:09 -05:00
The `capability` filter matches on plugin capabilities. One plugin
might have multiple capabilities. Currently `volumedriver` , `networkdriver` ,
2017-04-13 21:56:50 -04:00
`ipamdriver` , `logdriver` , `metricscollector` , and `authz` are supported capabilities.
2016-11-23 08:27:09 -05:00
2021-08-21 08:54:14 -04:00
```console
2017-08-07 05:04:05 -04:00
$ docker plugin install --disable vieux/sshfs
2017-02-07 18:42:48 -05:00
2017-08-07 05:04:05 -04:00
Installed plugin vieux/sshfs
2016-11-23 08:27:09 -05:00
$ docker plugin ls --filter enabled=true
2017-02-07 18:42:48 -05:00
2020-06-18 10:37:36 -04:00
ID NAME DESCRIPTION ENABLED
2016-11-23 08:27:09 -05:00
```
2023-01-06 13:28:29 -05:00
### <a name="format"></a> Format the output (--format)
2016-11-22 19:23:21 -05:00
The formatting options (`--format`) pretty-prints plugins output
using a Go template.
Valid placeholders for the Go template are listed below:
2022-03-30 08:33:44 -04:00
| Placeholder | Description |
|--------------------|-------------------------------------------------|
| `.ID` | Plugin ID |
| `.Name` | Plugin name and tag |
| `.Description` | Plugin description |
| `.Enabled` | Whether plugin is enabled or not |
| `.PluginReference` | The reference used to push/pull from a registry |
2016-11-22 19:23:21 -05:00
When using the `--format` option, the `plugin ls` command will either
output 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
2020-04-19 11:23:09 -04:00
`ID` and `Name` entries separated by a colon (`:`) for all plugins:
2016-11-22 19:23:21 -05:00
2021-08-21 08:54:14 -04:00
```console
2016-11-22 19:23:21 -05:00
$ docker plugin ls --format "{{.ID}}: {{.Name}}"
2017-02-07 18:42:48 -05:00
2017-08-07 05:04:05 -04:00
4be01827a72e: vieux/sshfs:latest
2016-11-22 19:23:21 -05:00
```
2021-03-09 18:49:33 -05:00
To list all plugins in JSON format, use the `json` directive:
```console
$ docker plugin ls --format json
{"Description":"sshFS plugin for Docker","Enabled":false,"ID":"856d89febb1c","Name":"vieux/sshfs:latest","PluginReference":"docker.io/vieux/sshfs:latest"}
```
2017-02-07 18:42:48 -05:00
## Related commands
2016-06-09 17:57:15 -04:00
2016-10-04 15:01:19 -04:00
* [plugin create ](plugin_create.md )
2016-06-09 17:57:15 -04:00
* [plugin disable ](plugin_disable.md )
2016-11-14 11:38:06 -05:00
* [plugin enable ](plugin_enable.md )
2016-06-09 17:57:15 -04:00
* [plugin inspect ](plugin_inspect.md )
* [plugin install ](plugin_install.md )
2016-11-14 11:38:06 -05:00
* [plugin push ](plugin_push.md )
2016-06-09 17:57:15 -04:00
* [plugin rm ](plugin_rm.md )
2016-10-31 20:07:05 -04:00
* [plugin set ](plugin_set.md )
2017-01-28 19:54:32 -05:00
* [plugin upgrade ](plugin_upgrade.md )