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