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

     1  ---
     2  title: "plugin install"
     3  description: "the plugin install command description and usage"
     4  keywords: "plugin, install"
     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 install
    17  
    18  ```markdown
    19  Usage:  docker plugin install [OPTIONS] PLUGIN [KEY=VALUE...]
    20  
    21  Install a plugin
    22  
    23  Options:
    24        --alias string            Local name for plugin
    25        --disable                 Do not enable the plugin on install
    26        --disable-content-trust   Skip image verification (default true)
    27        --grant-all-permissions   Grant all permissions necessary to run the plugin
    28        --help                    Print usage
    29  ```
    30  
    31  ## Description
    32  
    33  Installs and enables a plugin. Docker looks first for the plugin on your Docker
    34  host. If the plugin does not exist locally, then the plugin is pulled from
    35  the registry. Note that the minimum required registry version to distribute
    36  plugins is 2.3.0
    37  
    38  ## Examples
    39  
    40  The following example installs `vieus/sshfs` plugin and [sets](plugin_set.md) its
    41  `DEBUG` environment variable to `1`. To install, `pull` the plugin from Docker
    42  Hub and prompt the user to accept the list of privileges that the plugin needs,
    43  set the plugin's parameters and enable the plugin.
    44  
    45  ```bash
    46  $ docker plugin install vieux/sshfs DEBUG=1
    47  
    48  Plugin "vieux/sshfs" is requesting the following privileges:
    49   - network: [host]
    50   - device: [/dev/fuse]
    51   - capabilities: [CAP_SYS_ADMIN]
    52  Do you grant the above permissions? [y/N] y
    53  vieux/sshfs
    54  ```
    55  
    56  After the plugin is installed, it appears in the list of plugins:
    57  
    58  ```bash
    59  $ docker plugin ls
    60  
    61  ID                  NAME                  TAG                 DESCRIPTION                ENABLED
    62  69553ca1d123        vieux/sshfs           latest              sshFS plugin for Docker    true
    63  ```
    64  
    65  ## Related commands
    66  
    67  * [plugin create](plugin_create.md)
    68  * [plugin disable](plugin_disable.md)
    69  * [plugin enable](plugin_enable.md)
    70  * [plugin inspect](plugin_inspect.md)
    71  * [plugin ls](plugin_ls.md)
    72  * [plugin push](plugin_push.md)
    73  * [plugin rm](plugin_rm.md)
    74  * [plugin set](plugin_set.md)
    75  * [plugin upgrade](plugin_upgrade.md)