Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add plugin list subcommand to CLI #27

Merged
merged 1 commit into from
Sep 5, 2023
Merged

Add plugin list subcommand to CLI #27

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions using-gatewayd/CLI.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)` |

Expand Down
Loading