github.com/AliyunContainerService/cli@v0.0.0-20181009023821-814ced4b30d0/docs/reference/commandline/plugin_ls.md (about)

     1  ---
     2  title: "plugin ls"
     3  description: "The plugin ls command description and usage"
     4  keywords: "plugin, list"
     5  ---
     6  
     7  <!-- This file is maintained within the docker/cli GitHub
     8       repository at https://github.com/docker/cli/. Make all
     9       pull requests against that repo. If you see this file in
    10       another repository, consider it read-only there, as it will
    11       periodically be overwritten by the definitive file. Pull
    12       requests which include edits to this file in other repositories
    13       will be rejected.
    14  -->
    15  
    16  # plugin ls
    17  
    18  ```markdown
    19  Usage:  docker plugin ls [OPTIONS]
    20  
    21  List plugins
    22  
    23  Aliases:
    24    ls, list
    25  
    26  Options:
    27    -f, --filter filter   Provide filter values (e.g. 'enabled=true')
    28        --format string   Pretty-print plugins using a Go template
    29        --help            Print usage
    30        --no-trunc        Don't truncate output
    31    -q, --quiet           Only display plugin IDs
    32  ```
    33  
    34  ## Description
    35  
    36  Lists all the plugins that are currently installed. You can install plugins
    37  using the [`docker plugin install`](plugin_install.md) command.
    38  You can also filter using the `-f` or `--filter` flag.
    39  Refer to the [filtering](#filtering) section for more information about available filter options.
    40  
    41  ## Examples
    42  
    43  ```bash
    44  $ docker plugin ls
    45  
    46  ID                  NAME                             TAG                 DESCRIPTION                ENABLED
    47  69553ca1d123        tiborvass/sample-volume-plugin   latest              A test plugin for Docker   true
    48  ```
    49  
    50  ### Filtering
    51  
    52  The filtering flag (`-f` or `--filter`) format is of "key=value". If there is more
    53  than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`)
    54  
    55  The currently supported filters are:
    56  
    57  * enabled (boolean - true or false, 0 or 1)
    58  * capability (string - currently `volumedriver`, `networkdriver`, `ipamdriver`, `logdriver`, `metricscollector`, or `authz`)
    59  
    60  #### enabled
    61  
    62  The `enabled` filter matches on plugins enabled or disabled.
    63  
    64  #### capability
    65  
    66  The `capability` filter matches on plugin capabilities. One plugin
    67  might have multiple capabilities. Currently `volumedriver`, `networkdriver`,
    68  `ipamdriver`, `logdriver`, `metricscollector`, and `authz` are supported capabilities.
    69  
    70  ```bash
    71  $ docker plugin install --disable vieux/sshfs
    72  
    73  Installed plugin vieux/sshfs
    74  
    75  $ docker plugin ls --filter enabled=true
    76  
    77  NAME                  TAG                 DESCRIPTION                ENABLED
    78  ```
    79  
    80  ### Formatting
    81  
    82  The formatting options (`--format`) pretty-prints plugins output
    83  using a Go template.
    84  
    85  Valid placeholders for the Go template are listed below:
    86  
    87  Placeholder    | Description
    88  ---------------|------------------------------------------------------------------------------------------
    89  `.ID`              | Plugin ID
    90  `.Name`            | Plugin name
    91  `.Description`     | Plugin description
    92  `.Enabled`         | Whether plugin is enabled or not
    93  `.PluginReference` | The reference used to push/pull from a registry
    94  
    95  When using the `--format` option, the `plugin ls` command will either
    96  output the data exactly as the template declares or, when using the
    97  `table` directive, includes column headers as well.
    98  
    99  The following example uses a template without headers and outputs the
   100  `ID` and `Name` entries separated by a colon for all plugins:
   101  
   102  ```bash
   103  $ docker plugin ls --format "{{.ID}}: {{.Name}}"
   104  
   105  4be01827a72e: vieux/sshfs:latest
   106  ```
   107  
   108  ## Related commands
   109  
   110  * [plugin create](plugin_create.md)
   111  * [plugin disable](plugin_disable.md)
   112  * [plugin enable](plugin_enable.md)
   113  * [plugin inspect](plugin_inspect.md)
   114  * [plugin install](plugin_install.md)
   115  * [plugin push](plugin_push.md)
   116  * [plugin rm](plugin_rm.md)
   117  * [plugin set](plugin_set.md)
   118  * [plugin upgrade](plugin_upgrade.md)