github.com/khulnasoft/cli@v0.0.0-20240402070845-01bcad7beefa/docs/reference/commandline/plugin_inspect.md (about)

     1  # plugin inspect
     2  
     3  <!---MARKER_GEN_START-->
     4  Display detailed information on one or more plugins
     5  
     6  ### Options
     7  
     8  | Name                                   | Type     | Default | Description                                                                                                                                                                                                                                                        |
     9  |:---------------------------------------|:---------|:--------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
    10  | [`-f`](#format), [`--format`](#format) | `string` |         | Format output using a custom 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 |
    11  
    12  
    13  <!---MARKER_GEN_END-->
    14  
    15  ## Description
    16  
    17  Returns information about a plugin. By default, this command renders all results
    18  in a JSON array.
    19  
    20  ## Examples
    21  
    22  ### Inspect a plugin
    23  
    24  The following example inspects the `tiborvass/sample-volume-plugin` plugin:
    25  
    26  ```console
    27  $ docker plugin inspect tiborvass/sample-volume-plugin:latest
    28  ```
    29  
    30  Output is in JSON format (output below is formatted for readability):
    31  
    32  ```json
    33  {
    34    "Id": "8c74c978c434745c3ade82f1bc0acf38d04990eaf494fa507c16d9f1daa99c21",
    35    "Name": "tiborvass/sample-volume-plugin:latest",
    36    "PluginReference": "tiborvas/sample-volume-plugin:latest",
    37    "Enabled": true,
    38    "Config": {
    39      "Mounts": [
    40        {
    41          "Name": "",
    42          "Description": "",
    43          "Settable": null,
    44          "Source": "/data",
    45          "Destination": "/data",
    46          "Type": "bind",
    47          "Options": [
    48            "shared",
    49            "rbind"
    50          ]
    51        },
    52        {
    53          "Name": "",
    54          "Description": "",
    55          "Settable": null,
    56          "Source": null,
    57          "Destination": "/foobar",
    58          "Type": "tmpfs",
    59          "Options": null
    60        }
    61      ],
    62      "Env": [
    63        "DEBUG=1"
    64      ],
    65      "Args": null,
    66      "Devices": null
    67    },
    68    "Manifest": {
    69      "ManifestVersion": "v0",
    70      "Description": "A test plugin for Docker",
    71      "Documentation": "https://docs.docker.com/engine/extend/plugins/",
    72      "Interface": {
    73        "Types": [
    74          "docker.volumedriver/1.0"
    75        ],
    76        "Socket": "plugins.sock"
    77      },
    78      "Entrypoint": [
    79        "plugin-sample-volume-plugin",
    80        "/data"
    81      ],
    82      "Workdir": "",
    83      "User": {
    84      },
    85      "Network": {
    86        "Type": "host"
    87      },
    88      "Capabilities": null,
    89      "Mounts": [
    90        {
    91          "Name": "",
    92          "Description": "",
    93          "Settable": null,
    94          "Source": "/data",
    95          "Destination": "/data",
    96          "Type": "bind",
    97          "Options": [
    98            "shared",
    99            "rbind"
   100          ]
   101        },
   102        {
   103          "Name": "",
   104          "Description": "",
   105          "Settable": null,
   106          "Source": null,
   107          "Destination": "/foobar",
   108          "Type": "tmpfs",
   109          "Options": null
   110        }
   111      ],
   112      "Devices": [
   113        {
   114          "Name": "device",
   115          "Description": "a host device to mount",
   116          "Settable": null,
   117          "Path": "/dev/cpu_dma_latency"
   118        }
   119      ],
   120      "Env": [
   121        {
   122          "Name": "DEBUG",
   123          "Description": "If set, prints debug messages",
   124          "Settable": null,
   125          "Value": "1"
   126        }
   127      ],
   128      "Args": {
   129        "Name": "args",
   130        "Description": "command line arguments",
   131        "Settable": null,
   132        "Value": [
   133  
   134        ]
   135      }
   136    }
   137  }
   138  ```
   139  
   140  
   141  ### <a name="format"></a> Format the output (--format)
   142  
   143  ```console
   144  $ docker plugin inspect -f '{{.Id}}' tiborvass/sample-volume-plugin:latest
   145  
   146  8c74c978c434745c3ade82f1bc0acf38d04990eaf494fa507c16d9f1daa99c21
   147  ```
   148  
   149  ## Related commands
   150  
   151  * [plugin create](plugin_create.md)
   152  * [plugin enable](plugin_enable.md)
   153  * [plugin disable](plugin_disable.md)
   154  * [plugin install](plugin_install.md)
   155  * [plugin ls](plugin_ls.md)
   156  * [plugin push](plugin_push.md)
   157  * [plugin rm](plugin_rm.md)
   158  * [plugin set](plugin_set.md)
   159  * [plugin upgrade](plugin_upgrade.md)