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

     1  # plugin install
     2  
     3  <!---MARKER_GEN_START-->
     4  Install a plugin
     5  
     6  ### Options
     7  
     8  | Name                      | Type     | Default | Description                                       |
     9  |:--------------------------|:---------|:--------|:--------------------------------------------------|
    10  | `--alias`                 | `string` |         | Local name for plugin                             |
    11  | `--disable`               |          |         | Do not enable the plugin on install               |
    12  | `--disable-content-trust` | `bool`   | `true`  | Skip image verification                           |
    13  | `--grant-all-permissions` |          |         | Grant all permissions necessary to run the plugin |
    14  
    15  
    16  <!---MARKER_GEN_END-->
    17  
    18  ## Description
    19  
    20  Installs and enables a plugin. Docker looks first for the plugin on your Docker
    21  host. If the plugin does not exist locally, then the plugin is pulled from
    22  the registry. Note that the minimum required registry version to distribute
    23  plugins is 2.3.0.
    24  
    25  ## Examples
    26  
    27  The following example installs `vieus/sshfs` plugin and [sets](plugin_set.md) its
    28  `DEBUG` environment variable to `1`. To install, `pull` the plugin from Docker
    29  Hub and prompt the user to accept the list of privileges that the plugin needs,
    30  set the plugin's parameters and enable the plugin.
    31  
    32  ```console
    33  $ docker plugin install vieux/sshfs DEBUG=1
    34  
    35  Plugin "vieux/sshfs" is requesting the following privileges:
    36   - network: [host]
    37   - device: [/dev/fuse]
    38   - capabilities: [CAP_SYS_ADMIN]
    39  Do you grant the above permissions? [y/N] y
    40  vieux/sshfs
    41  ```
    42  
    43  After the plugin is installed, it appears in the list of plugins:
    44  
    45  ```console
    46  $ docker plugin ls
    47  
    48  ID             NAME                  DESCRIPTION                ENABLED
    49  69553ca1d123   vieux/sshfs:latest    sshFS plugin for Docker    true
    50  ```
    51  
    52  ## Related commands
    53  
    54  * [plugin create](plugin_create.md)
    55  * [plugin disable](plugin_disable.md)
    56  * [plugin enable](plugin_enable.md)
    57  * [plugin inspect](plugin_inspect.md)
    58  * [plugin ls](plugin_ls.md)
    59  * [plugin push](plugin_push.md)
    60  * [plugin rm](plugin_rm.md)
    61  * [plugin set](plugin_set.md)
    62  * [plugin upgrade](plugin_upgrade.md)