Skip to content

Commit bb5e099

Browse files
authored
Merge pull request #28 from gatewayd-io/install-from-local-file
Update CLI docs to mention that plugin install can install from locally downloaded archives
2 parents 96690c9 + 588d51e commit bb5e099

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

using-gatewayd/CLI.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ GatewayD is a CLI application that runs on Windows, Linux-based distributions an
2020
| `help` | shows help about any subcommand | The `-h` or `--help` flag can be used to get more information about a specific subcommand. |
2121
| `plugin` | manages GatewayD plugins and their configurations | |
2222
| `plugin init` | generates a plugins configuration file | - `-p`, `--plugin-config`: plugins config file (default "gatewayd_plugins.yaml")<br/>- `-f`, `--force`: overwrites the existing config file<br/>- `--sentry`: Enable Sentry for error reporting (default `true`) |
23-
| `plugin install` | installs a plugin from GitHub | - `-p`, `--plugin-config`: plugins config file (default "gatewayd_plugins.yaml")<br/>- `-o`, `--output-dir`: output directory of the plugin, where the plugin is extracted (default "./plugins")<br/>- `--pull-only`: only pull the plugin, don't install it<br/>- `--sentry`: Enable Sentry for error reporting (default `true`) |
23+
| `plugin install` | installs a plugin from GitHub or a locally downloaded archive file | - `-p`, `--plugin-config`: plugins config file (default "gatewayd_plugins.yaml")<br/>- `-o`, `--output-dir`: output directory of the plugin, where the plugin is extracted (default "./plugins")<br/>- `--pull-only`: only pull the plugin, don't install it<br/>- `--sentry`: Enable Sentry for error reporting (default `true`) |
2424
| `plugin lint` | validates plugins configuration file | - `-p`, `--plugin-config`: plugins config file (default "gatewayd_plugins.yaml")<br/>- `--sentry`: Enable Sentry for error reporting (default `true`) |
2525
| `plugin list` | lists all installed plugins | - `-p`, `--plugin-config`: plugins config file (default "gatewayd_plugins.yaml")<br/>- `-e`, `--only-enabled`: Only list enabled plugins<br/>- `--sentry`: Enable Sentry for error reporting (default `true`) |
2626
| `run` | runs an instance of `gatewayd` with the specified configuration files | - `-c`, `--config`: global config file (default `"gatewayd.yaml"`)<br/>- `-p`, `--plugin-config`: plugin config file (default `"gatewayd_plugins.yaml"`)<br/>- `--tracing`: Enable tracing with OpenTelemetry via gRPC<br/>- `--collector-url string`: Collector URL of OpenTelemetry gRPC endpoint (default `"localhost:4317"`)<br/>- `--sentry`: Enable Sentry for error reporting (default `true`)<br/>- `--dev`: Enable development mode for plugin development<br/>- `--usage-report`: Enable usage report (default `true`) |

0 commit comments

Comments
 (0)