-
-
Notifications
You must be signed in to change notification settings - Fork 80.7k
Expand file tree
/
Copy pathplugins-cli.ts
More file actions
261 lines (234 loc) · 9.06 KB
/
Copy pathplugins-cli.ts
File metadata and controls
261 lines (234 loc) · 9.06 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
// Commander registration for plugin list/search/inspect/install/update/authoring commands.
import type { Command } from "commander";
import { formatDocsLink } from "../../packages/terminal-core/src/links.js";
import { theme } from "../../packages/terminal-core/src/theme.js";
import type { PluginInspectOptions } from "./plugins-inspect-command.js";
import type { PluginsListOptions } from "./plugins-list-command.js";
import { parseStrictPositiveIntOption } from "./program/helpers.js";
import { applyParentDefaultHelpAction } from "./program/parent-default-help.js";
export type PluginUpdateOptions = {
all?: boolean;
dryRun?: boolean;
dangerouslyForceUnsafeInstall?: boolean;
};
export type PluginMarketplaceListOptions = {
json?: boolean;
};
export type PluginSearchOptions = {
json?: boolean;
limit?: number;
};
export type PluginUninstallOptions = {
keepFiles?: boolean;
/** @deprecated Use keepFiles. */
keepConfig?: boolean;
force?: boolean;
dryRun?: boolean;
};
export type PluginRegistryOptions = {
json?: boolean;
refresh?: boolean;
};
export type PluginAuthoringBuildOptions = {
root?: string;
entry?: string;
check?: boolean;
};
export type PluginAuthoringValidateOptions = {
root?: string;
entry?: string;
};
export type PluginAuthoringInitOptions = {
directory?: string;
force?: boolean;
name?: string;
};
function createModuleLoader<T>(load: () => Promise<T>): () => Promise<T> {
// Plugin runtime modules are heavy; load each command surface once on first use.
let promise: Promise<T> | undefined;
return () => (promise ??= load());
}
const loadPluginsRuntime = createModuleLoader(() => import("./plugins-cli.runtime.js"));
const loadPluginsAuthoringCommands = createModuleLoader(
() => import("./plugins-authoring-command.js"),
);
export function registerPluginsCli(program: Command) {
const plugins = program
.command("plugins")
.description("Manage OpenClaw plugins and extensions")
.addHelpText(
"after",
() =>
`\n${theme.muted("Docs:")} ${formatDocsLink("/cli/plugins", "docs.openclaw.ai/cli/plugins")}\n`,
);
plugins
.command("list")
.description("List discovered plugins")
.option("--json", "Print JSON")
.option("--enabled", "Only show enabled plugins", false)
.option("--verbose", "Show detailed entries", false)
.action(async (opts: PluginsListOptions) => {
const { runPluginsListCommand } = await import("./plugins-list-command.js");
await runPluginsListCommand(opts);
});
plugins
.command("search")
.description("Search ClawHub plugin packages")
.argument("[query...]", "Search query")
.option("--limit <n>", "Max results", (value) => parseStrictPositiveIntOption(value, "--limit"))
.option("--json", "Print JSON", false)
.action(async (queryParts: string[], opts: PluginSearchOptions) => {
const { runPluginsSearchCommand } = await import("./plugins-search-command.js");
await runPluginsSearchCommand(queryParts, opts);
});
plugins
.command("inspect")
.alias("info")
.description("Inspect plugin details")
.argument("[id]", "Plugin id")
.option("--all", "Inspect all plugins")
.option("--runtime", "Load plugin runtime for hooks/tools/diagnostics")
.option("--json", "Print JSON")
.action(async (id: string | undefined, opts: PluginInspectOptions) => {
const { runPluginsInspectCommand } = await import("./plugins-inspect-command.js");
await runPluginsInspectCommand(id, opts);
});
plugins
.command("enable")
.description("Enable a plugin in config")
.argument("<id>", "Plugin id")
.action(async (id: string) => {
const { runPluginsEnableCommand } = await loadPluginsRuntime();
await runPluginsEnableCommand(id);
});
plugins
.command("disable")
.description("Disable a plugin in config")
.argument("<id>", "Plugin id")
.action(async (id: string) => {
const { runPluginsDisableCommand } = await loadPluginsRuntime();
await runPluginsDisableCommand(id);
});
plugins
.command("uninstall")
.description("Uninstall a plugin")
.argument("<id>", "Plugin id")
.option("--keep-files", "Keep installed files on disk", false)
.option("--keep-config", "Deprecated alias for --keep-files", false)
.option("--force", "Skip confirmation prompt", false)
.option("--dry-run", "Show what would be removed without making changes", false)
.action(async (id: string, opts: PluginUninstallOptions) => {
const { runPluginUninstallCommand } = await import("./plugins-uninstall-command.js");
await runPluginUninstallCommand(id, { ...opts, invalidateRuntimeCache: false });
});
plugins
.command("install")
.description(
"Install a plugin or hook pack (path, archive, npm spec, git repo, clawhub:package, or marketplace entry)",
)
.argument(
"<path-or-spec-or-plugin>",
"Path (.ts/.js/.zip/.tgz/.tar.gz), npm package spec, or marketplace plugin name",
)
.option("-l, --link", "Link a local path instead of copying", false)
.option("--force", "Overwrite an existing installed plugin or hook pack", false)
.option("--pin", "Record npm installs as exact resolved <name>@<version>", false)
.option(
"--dangerously-force-unsafe-install",
"Deprecated no-op; security.installPolicy may still block",
false,
)
.option(
"--marketplace <source>",
"Install a Claude marketplace plugin from a local repo/path or git/GitHub source",
)
.action(
async (
raw: string,
opts: {
dangerouslyForceUnsafeInstall?: boolean;
force?: boolean;
link?: boolean;
pin?: boolean;
marketplace?: string;
},
) => {
const { runPluginsInstallAction } = await loadPluginsRuntime();
await runPluginsInstallAction(raw, opts);
},
);
plugins
.command("update")
.description("Update installed plugins and tracked hook packs")
.argument("[id]", "Plugin or hook-pack id (omit with --all)")
.option("--all", "Update all tracked plugins and hook packs", false)
.option("--dry-run", "Show what would change without writing", false)
.option(
"--dangerously-force-unsafe-install",
"Deprecated no-op; security.installPolicy may still block",
false,
)
.action(async (id: string | undefined, opts: PluginUpdateOptions) => {
const { runPluginUpdateCommand } = await import("./plugins-update-command.js");
await runPluginUpdateCommand({ id, opts });
});
plugins
.command("registry")
.description("Inspect or rebuild the persisted plugin registry")
.option("--json", "Print JSON")
.option("--refresh", "Rebuild the persisted registry from current plugin manifests", false)
.action(async (opts: PluginRegistryOptions) => {
const { runPluginsRegistryCommand } = await loadPluginsRuntime();
await runPluginsRegistryCommand(opts);
});
plugins
.command("doctor")
.description("Report plugin load issues")
.action(async () => {
const { runPluginsDoctorCommand } = await loadPluginsRuntime();
await runPluginsDoctorCommand();
});
plugins
.command("build")
.description("Generate simple tool plugin metadata")
.option("--root <path>", "Plugin package root")
.option("--entry <path>", "Plugin entry module relative to --root")
.option("--check", "Fail if generated metadata is out of date", false)
.action(async (opts: PluginAuthoringBuildOptions) => {
const { runPluginsBuildCommand } = await loadPluginsAuthoringCommands();
await runPluginsBuildCommand(opts);
});
plugins
.command("validate")
.description("Validate simple tool plugin metadata")
.option("--root <path>", "Plugin package root")
.option("--entry <path>", "Plugin entry module relative to --root")
.action(async (opts: PluginAuthoringValidateOptions) => {
const { runPluginsValidateCommand } = await loadPluginsAuthoringCommands();
await runPluginsValidateCommand(opts);
});
plugins
.command("init")
.description("Create a simple tool plugin project")
.argument("<id>", "Plugin id")
.option("--directory <path>", "Output directory")
.option("--name <name>", "Display name")
.option("--force", "Overwrite an existing output directory", false)
.action(async (id: string, opts: PluginAuthoringInitOptions) => {
const { runPluginsInitCommand } = await loadPluginsAuthoringCommands();
await runPluginsInitCommand(id, opts);
});
const marketplace = plugins
.command("marketplace")
.description("Inspect Claude-compatible plugin marketplaces");
marketplace
.command("list")
.description("List plugins published by a marketplace source")
.argument("<source>", "Local marketplace path/repo or git/GitHub source")
.option("--json", "Print JSON")
.action(async (source: string, opts: PluginMarketplaceListOptions) => {
const { runPluginMarketplaceListCommand } = await loadPluginsRuntime();
await runPluginMarketplaceListCommand(source, opts);
});
applyParentDefaultHelpAction(plugins);
}