You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
(If your shell is PowerShell on Windows, use `$env:PROXXI_DIR="..."`.)
64
62
65
-
Proxxi will initialize required directories/files on first run.
63
+
> Proxxi will initialize required directories/files on the first run.
66
64
67
65
### Plugin configuration
68
66
69
-
Plugins are managed via a JSON-based configuration provider (stored under the Proxxi directory).
70
-
You typically configure:
67
+
You can manage plugins using the `plugin` command and its subcommands:
71
68
72
-
- which plugins are enabled
73
-
- plugin IDs (with optional aliases)
74
-
- plugin parameters
69
+
-`plugin <PLUGIN-ID> info` - Show information about a plugin
70
+
-`plugin <PLUGIN-ID> alias [ALIAS]` - Set or remove an alias for a plugin
71
+
-`plugin <PLUGIN-ID> enable` - Enable a plugin
72
+
-`plugin <PLUGIN-ID> disable` - Disable a plugin
73
+
-`plugin <PLUGIN-ID> parameter <NAME> [VALUE]` - Set or remove a parameter for a plugin
74
+
-`parameters` - List parameters for a plugin
75
+
76
+
You can also use the `plugins` command to list all installed plugins.
75
77
76
78
## Output formats
77
79
@@ -102,7 +104,7 @@ A plugin exposes one or more proxy sources, and the CLI orchestrates:
102
104
103
105
### Adding plugins
104
106
105
-
1.**Choose your Proxxi directory** (optional, but recommended for predictable paths):
107
+
1.**Choose your Proxxi directory** (optional but recommended for predictable paths):
106
108
```shell
107
109
export PROXXI_DIR="<PATH_TO_PROXXI_DIR>"
108
110
```
@@ -123,6 +125,7 @@ A plugin exposes one or more proxy sources, and the CLI orchestrates:
123
125
"path": "path/to/plugin/dll", // relative path from `$PROXXI_DIR/plugins/`
124
126
"alias": "publisher", // optional
125
127
"version": "1.0.0",
128
+
"enabled": true,
126
129
"params": {
127
130
// plugin parameters if needed
128
131
"param1": "value1",
@@ -132,7 +135,7 @@ A plugin exposes one or more proxy sources, and the CLI orchestrates:
132
135
]
133
136
```
134
137
135
-
> Tip: If a plugin is not discovered, ensure the plugin and its dependencies are present in the plugins folder and that the plugin is add/enabled in the JSON config.
138
+
> Tip: If a plugin is not discovered, ensure the plugin and its dependencies are present in the plugins folder and that the plugin is added/enabled in the JSON config.
0 commit comments