@fnndsc/brasa 0.56.3 → 0.57.0

package/dist/builtins/res/plugin.d.ts

@@ -1,9 +1,349 @@
 import { type CommandEnvelope } from '@fnndsc/menu';
 export { plugin_addInteractive } from './plugin.sync.js';
 /**
- * Handles plugin commands.
+ * `plugin <list|search|inspect|info|add|sync|validate|index> …`: the
+ * declaration. `plugins` is the same command, and a read.
  *
- * @param args - command arguments.
- * @returns An envelope carrying the rendered plugin output.
+ * @example
+ * ```ts
+ * commands_register({ declarations: [pluginCommand] }, 'backend');
+ * ```
+ */
+export declare const pluginCommand: import("../../core/commandDeclaration.js").CommandDeclaration<{
+    readonly subcommands: {
+        readonly list: {
+            readonly summary: "List the plugins, 20 to a page";
+            readonly options: {
+                readonly all: {
+                    readonly long: "all";
+                    readonly summary: "Fetch every page";
+                };
+                readonly limit: {
+                    readonly long: "limit";
+                    readonly summary: "Page size (default 20)";
+                    readonly value: {
+                        readonly name: "n";
+                        readonly kind: "int";
+                        readonly min: 1;
+                    };
+                };
+                readonly offset: {
+                    readonly long: "offset";
+                    readonly summary: "Start this many rows in";
+                    readonly value: {
+                        readonly name: "n";
+                        readonly kind: "int";
+                        readonly min: 0;
+                    };
+                };
+                readonly page: {
+                    readonly long: "page";
+                    readonly summary: "Page size, when --limit is not given";
+                    readonly value: {
+                        readonly name: "n";
+                        readonly kind: "int";
+                        readonly min: 1;
+                    };
+                };
+                readonly fields: {
+                    readonly long: "fields";
+                    readonly summary: "The columns to show, comma-separated (inspect names them)";
+                    readonly value: {
+                        readonly name: "field,…";
+                        readonly kind: "word";
+                    };
+                };
+                readonly search: {
+                    readonly long: "search";
+                    readonly summary: "Filter by field:value, comma-separated (inspect names the fields)";
+                    readonly value: {
+                        readonly name: "field:value";
+                        readonly kind: "word";
+                    };
+                };
+                readonly sort: {
+                    readonly long: "sort";
+                    readonly summary: "Sort by a field";
+                    readonly value: {
+                        readonly name: "field";
+                        readonly kind: "word";
+                    };
+                };
+                readonly reverse: {
+                    readonly long: "reverse";
+                    readonly summary: "Reverse the sort";
+                };
+                readonly table: {
+                    readonly long: "table";
+                    readonly summary: "Tabular output";
+                };
+                readonly csv: {
+                    readonly long: "csv";
+                    readonly summary: "CSV output";
+                };
+            };
+        };
+        readonly search: {
+            readonly summary: "List the plugins a filter matches (list --search <term>)";
+            readonly operands: readonly [{
+                readonly name: "term";
+                readonly kind: "word";
+                readonly optional: true;
+                readonly summary: "The filter: a name, field:value, id:42, or id:77++id:33";
+            }];
+            readonly options: {
+                readonly all: {
+                    readonly long: "all";
+                    readonly summary: "Fetch every page";
+                };
+                readonly limit: {
+                    readonly long: "limit";
+                    readonly summary: "Page size (default 20)";
+                    readonly value: {
+                        readonly name: "n";
+                        readonly kind: "int";
+                        readonly min: 1;
+                    };
+                };
+                readonly offset: {
+                    readonly long: "offset";
+                    readonly summary: "Start this many rows in";
+                    readonly value: {
+                        readonly name: "n";
+                        readonly kind: "int";
+                        readonly min: 0;
+                    };
+                };
+                readonly page: {
+                    readonly long: "page";
+                    readonly summary: "Page size, when --limit is not given";
+                    readonly value: {
+                        readonly name: "n";
+                        readonly kind: "int";
+                        readonly min: 1;
+                    };
+                };
+                readonly fields: {
+                    readonly long: "fields";
+                    readonly summary: "The columns to show, comma-separated (inspect names them)";
+                    readonly value: {
+                        readonly name: "field,…";
+                        readonly kind: "word";
+                    };
+                };
+                readonly search: {
+                    readonly long: "search";
+                    readonly summary: "Filter by field:value, comma-separated (inspect names the fields)";
+                    readonly value: {
+                        readonly name: "field:value";
+                        readonly kind: "word";
+                    };
+                };
+                readonly sort: {
+                    readonly long: "sort";
+                    readonly summary: "Sort by a field";
+                    readonly value: {
+                        readonly name: "field";
+                        readonly kind: "word";
+                    };
+                };
+                readonly reverse: {
+                    readonly long: "reverse";
+                    readonly summary: "Reverse the sort";
+                };
+                readonly table: {
+                    readonly long: "table";
+                    readonly summary: "Tabular output";
+                };
+                readonly csv: {
+                    readonly long: "csv";
+                    readonly summary: "CSV output";
+                };
+            };
+        };
+        readonly inspect: {
+            readonly summary: "Name the fields a plugin has";
+        };
+        readonly info: {
+            readonly summary: "Show one plugin version whole: its facts and every parameter";
+            readonly operands: readonly [{
+                readonly name: "plugin";
+                readonly kind: "plugin";
+                readonly summary: "The version as /bin names it, <name>-v<version>; or the name, with the version after";
+            }, {
+                readonly name: "version";
+                readonly kind: "word";
+                readonly optional: true;
+                readonly summary: "The version, when the plugin is given by name";
+            }];
+        };
+        readonly add: {
+            readonly summary: "Register a plugin: by name or image (the peer store, then the image), a plugin URL in another CUBE, or a descriptor file";
+            readonly operands: readonly [{
+                readonly name: "input";
+                readonly kind: "word";
+                readonly optional: true;
+                readonly unless: "json";
+                readonly summary: "A plugin name, a Docker image, or a plugin URL in another CUBE";
+            }];
+            readonly options: {
+                readonly json: {
+                    readonly long: "json";
+                    readonly summary: "Register one descriptor file: a host path, or cube:<path> for one in CUBE";
+                    readonly value: {
+                        readonly name: "file";
+                        readonly kind: "word";
+                    };
+                };
+                readonly compute: {
+                    readonly long: "compute";
+                    readonly summary: "The compute resources to register it on, comma-separated (default: all)";
+                    readonly value: {
+                        readonly name: "resources";
+                        readonly kind: "compute";
+                    };
+                };
+                readonly store: {
+                    readonly long: "store";
+                    readonly summary: "The peer store to look in (default: cube.chrisproject.org)";
+                    readonly value: {
+                        readonly name: "url";
+                        readonly kind: "word";
+                    };
+                };
+                readonly adminUser: {
+                    readonly long: "adminUser";
+                    readonly summary: "An administrator to act as (sudo asks instead)";
+                    readonly value: {
+                        readonly name: "username";
+                        readonly kind: "word";
+                    };
+                };
+                readonly adminPassword: {
+                    readonly long: "adminPassword";
+                    readonly summary: "That administrator's password (sudo asks instead)";
+                    readonly value: {
+                        readonly name: "password";
+                        readonly kind: "word";
+                    };
+                };
+                readonly publicRepo: {
+                    readonly long: "publicRepo";
+                    readonly summary: "The plugin's public repository";
+                    readonly value: {
+                        readonly name: "url";
+                        readonly kind: "word";
+                    };
+                };
+            };
+        };
+        readonly sync: {
+            readonly summary: "Fill this CUBE from a plugin index: show the plan, ask, register what is missing";
+            readonly operands: readonly [{
+                readonly name: "source";
+                readonly kind: "word";
+                readonly optional: true;
+                readonly summary: "owner/repo[@ref] on GitHub, a CUBE path (cube:<path>: a directory of .json, or a .tar.gz), or host:<path>";
+            }];
+            readonly options: {
+                readonly ref: {
+                    readonly long: "ref";
+                    readonly summary: "Pin the index at a tag or commit";
+                    readonly value: {
+                        readonly name: "ref";
+                        readonly kind: "word";
+                    };
+                };
+                readonly plan: {
+                    readonly long: "plan";
+                    readonly summary: "Show the plan and stop";
+                };
+                readonly yes: {
+                    readonly long: "yes";
+                    readonly summary: "Apply the plan without asking";
+                };
+                readonly compute: {
+                    readonly long: "compute";
+                    readonly summary: "Register on these compute resources (default: all of them)";
+                    readonly value: {
+                        readonly name: "resources";
+                        readonly kind: "compute";
+                    };
+                };
+            };
+        };
+        readonly validate: {
+            readonly summary: "Check descriptors without a CUBE";
+            readonly operands: readonly [{
+                readonly summary: "A descriptor file or directory (a host path), owner/repo[@ref], or cube:<path>";
+                readonly name: "source";
+                readonly kind: "word";
+                readonly optional: true;
+            }];
+            readonly options: {
+                readonly ref: {
+                    readonly long: "ref";
+                    readonly summary: "Pin the index at a tag or commit";
+                    readonly value: {
+                        readonly name: "ref";
+                        readonly kind: "word";
+                    };
+                };
+                readonly offline: {
+                    readonly long: "offline";
+                    readonly summary: "Skip rule 5, the registry lookups; the report says it was not checked";
+                };
+            };
+        };
+        readonly index: {
+            readonly summary: "Show or set the index sync reads";
+            readonly operands: readonly [{
+                readonly name: "source";
+                readonly kind: "word";
+                readonly optional: true;
+                readonly summary: "owner/repo[@ref] to read from now on";
+            }];
+            readonly options: {
+                readonly reset: {
+                    readonly long: "reset";
+                    readonly summary: "Restore FNNDSC/chris-plugins@main";
+                };
+            };
+        };
+        readonly run: {
+            readonly summary: "Retired: a plugin runs by its name, as a line of its own";
+            readonly operands: readonly [{
+                readonly name: "words";
+                readonly kind: "word";
+                readonly optional: true;
+                readonly repeat: true;
+                readonly summary: "Anything; nothing runs";
+            }];
+            readonly options: {
+                readonly anything: {
+                    readonly long: "<option>";
+                    readonly summary: "Any option the old line took; nothing runs";
+                    readonly value: {
+                        readonly name: "value";
+                        readonly kind: "word";
+                    };
+                    readonly family: {
+                        readonly pattern: RegExp;
+                    };
+                };
+            };
+        };
+    };
+}>;
+/**
+ * `plugin` over words already split: the declaration's parse and handler.
+ *
+ * @param args - The words after `plugin`.
+ * @returns The answer, or the refusal of a bad line.
+ *
+ * @example
+ * ```ts
+ * await builtin_plugin(['search', 'name:dircopy']);
+ * ```
  */
 export declare function builtin_plugin(args: string[]): Promise<CommandEnvelope>;