Skip to content

Commit

Permalink
Update CLI docs to mention that plugin install can install from local…
Browse files Browse the repository at this point in the history 
…ly downloaded archives (this comment is bigger than the change)
  • Loading branch information
@mostafa
mostafa committed Sep 5, 2023
1 parent 877666e commit 588d51e
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion using-gatewayd/CLI.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ GatewayD is a CLI application that runs on Windows, Linux-based distributions an
| `help` | shows help about any subcommand | The `-h` or `--help` flag can be used to get more information about a specific subcommand. |
| `plugin` | manages GatewayD plugins and their configurations | |
| `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 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`) |
| `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`) |
| `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)` |
Expand Down

0 comments on commit 588d51e

Please sign in to comment.