Documentation
CLI Reference
eg plugins
eg plugin install
Description
Installs a plugin
Usage
eg plugin install [options] <package>
Notes:
<package>is any valid npm package specifier (e.g.,ExpressGateway/express-gateway-plugin-example#master)Options
| Name, longform | Type | Default | Description | Required |
|---|---|---|---|---|
-n, --enable |
boolean |
true |
Enable plugin in system config | Optional |
-g, --update-gateway-config |
boolean |
true |
Update policy whitelist in gateway config | Optional |
-o, --option |
string |
Plugin options in the form [-o ‘foo=bar’] | Optional |
Examples
Install the example plugin from npm
$ eg plugin install express-gateway-plugin-example
? Set value for baseUrl: http://example.com
? Set value for maxRequestsPerSecond: 234
? Would you like to enable this plugin in system config? Yes
? Would you like to add new policies to gateway config? Yes
Plugin installed!
Install the example plugin from GitHub
eg plugin install ExpressGateway/express-gateway-plugin-example
? Set value for baseUrl: http://example.com
? Set value for maxRequestsPerSecond: 234
? Would you like to enable this plugin in system config? Yes
? Would you like to add new policies to gateway config? Yes
Plugin installed!