Merge pull request #27 from gatewayd-io/add-plugin-list-subcommand

Add plugin list subcommand to CLI
gatewayd-io · Sep 5, 2023 · 96690c9 · 96690c9
2 parents ca7aa05 + 46b0b43
commit 96690c9
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/using-gatewayd/CLI.md b/using-gatewayd/CLI.md
@@ -22,6 +22,7 @@ GatewayD is a CLI application that runs on Windows, Linux-based distributions an
 | `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`)                                                                                                                                                                                                                                                                                                                 |
 | `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`)                                                                                                                                                                                                |
 | `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`)                                                                                                                                                                                                                                                                                                                                                                            |
+| `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`)                                                                                                                                                                                                                                                                                                                    |
 | `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`) |
 | `version`        | shows version information                                             | `GatewayD v0.6.0 (2023-03-12T22:22:55+0000/ae469dc, go1.20.1, linux/amd64)`                                                                                                                                                                                                                                                                                                                                                                                                                                                      |