@fnndsc/brasa 0.56.2 → 0.56.4

package/dist/builtins/proc.d.ts

@@ -7,9 +7,216 @@ import { type ProcUniverseModel, type CommandEnvelope } from '@fnndsc/menu';
  */
 export declare function procUniverseModel_build(): ProcUniverseModel;
 /**
- * Handles proc commands.
+ * `proc <jobs|stat|feeds|seen|universe|layout|refresh|retry|find|here|jump|watch|unwatch>`: the declaration.
  *
- * @param args - command arguments.
- * @returns An envelope carrying the subcommand's output.
+ * @example
+ * ```ts
+ * commands_register({ declarations: [procCommand] }, 'backend');
+ * ```
+ */
+export declare const procCommand: import("../core/commandDeclaration.js").CommandDeclaration<{
+    readonly bare: {
+        readonly summary: "Rebuild the entire proc cache (as refresh)";
+    };
+    readonly subcommands: {
+        readonly jobs: {
+            readonly summary: "List all feeds with their counter fields (default 20), or inspect the field names";
+            readonly operands: readonly [{
+                readonly name: "view";
+                readonly kind: "enum";
+                readonly values: readonly ["list", "inspect"];
+                readonly optional: true;
+                readonly summary: "list (the default), or inspect: every field name";
+            }];
+            readonly options: {
+                readonly fields: {
+                    readonly long: "fields";
+                    readonly summary: "Select columns";
+                    readonly value: {
+                        readonly name: "f,f";
+                        readonly kind: "word";
+                    };
+                };
+                readonly sort: {
+                    readonly long: "sort";
+                    readonly summary: "Sort by 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 all: {
+                    readonly long: "all";
+                    readonly summary: "All feeds (no limit)";
+                };
+                readonly limit: {
+                    readonly long: "limit";
+                    readonly summary: "Feeds to show (default 20)";
+                    readonly value: {
+                        readonly name: "n";
+                        readonly kind: "int";
+                        readonly min: 1;
+                    };
+                };
+                readonly search: {
+                    readonly long: "search";
+                    readonly summary: "Filter by title substring";
+                    readonly value: {
+                        readonly name: "term";
+                        readonly kind: "word";
+                    };
+                };
+                readonly force: {
+                    readonly long: "force";
+                    readonly summary: "Wait for warm-up, then answer from the complete index";
+                };
+            };
+        };
+        readonly stat: {
+            readonly summary: "Show the cache summary, or one feed's raw counters and topology state";
+            readonly operands: readonly [{
+                readonly optional: true;
+                readonly name: "feed";
+                readonly kind: "word";
+                readonly summary: "The feed: feed_N or its id";
+            }];
+        };
+        readonly feeds: {
+            readonly summary: "Find feeds by title, feed_N name or id; an id the roster lacks is asked of CUBE";
+            readonly operands: readonly [{
+                readonly name: "query";
+                readonly kind: "word";
+                readonly optional: true;
+                readonly summary: "Title substring, feed_N or id; none lists the whole roster";
+            }];
+            readonly options: {
+                readonly fresh: {
+                    readonly long: "fresh";
+                    readonly summary: "Walk the whole feed index now";
+                };
+                readonly new: {
+                    readonly long: "new";
+                    readonly summary: "Feeds shared with you since your last visit, not yet opened (NEW)";
+                };
+                readonly force: {
+                    readonly long: "force";
+                    readonly summary: "Wait for warm-up, then answer from the complete index";
+                };
+            };
+        };
+        readonly seen: {
+            readonly summary: "Take the NEW mark off feeds you have looked at";
+            readonly operands: readonly [{
+                readonly name: "feeds";
+                readonly kind: "word";
+                readonly repeat: true;
+                readonly summary: "feed_N or N, or all";
+            }];
+        };
+        readonly universe: {
+            readonly summary: "Every feed the index holds as it landed: size, status, pipeline shape; honest while warming";
+        };
+        readonly layout: {
+            readonly summary: "Where a surface last laid the universe out under a layout; put keeps one (node ids to [x, y, z], as JSON)";
+            readonly operands: readonly [{
+                readonly name: "layout";
+                readonly kind: "word";
+                readonly summary: "The layout's name; or put, to keep one";
+            }, {
+                readonly name: "name";
+                readonly kind: "word";
+                readonly optional: true;
+                readonly summary: "With put: the layout's name";
+            }, {
+                readonly name: "places";
+                readonly kind: "word";
+                readonly optional: true;
+                readonly summary: "With put: node ids to [x, y, z], as JSON";
+            }];
+        };
+        readonly refresh: {
+            readonly summary: "Rebuild the entire proc cache, or one feed's";
+            readonly operands: readonly [{
+                readonly optional: true;
+                readonly name: "feed";
+                readonly kind: "word";
+                readonly summary: "The feed: feed_N or its id";
+            }];
+        };
+        readonly retry: {
+            readonly summary: "Resume a failed topology sweep at its failed page";
+        };
+        readonly find: {
+            readonly summary: "Find a job: an instance id (available during warm-up), or a plugin name";
+            readonly operands: readonly [{
+                readonly name: "query";
+                readonly kind: "word";
+                readonly summary: "An instance id, or a plugin name substring";
+            }];
+            readonly options: {
+                readonly force: {
+                    readonly long: "force";
+                    readonly summary: "Wait for warm-up, then answer from the complete index";
+                };
+            };
+        };
+        readonly here: {
+            readonly summary: "Navigate from a CFS feed/output path to its matching job";
+        };
+        readonly jump: {
+            readonly summary: "Go to a feed or node by id or /proc name (feed_N, plugin_N); a number that is both is not guessed";
+            readonly operands: readonly [{
+                readonly name: "target";
+                readonly kind: "word";
+                readonly summary: "A feed id, node id, feed_N or plugin_N";
+            }];
+            readonly options: {
+                readonly where: {
+                    readonly long: "where";
+                    readonly summary: "Only answer where it is; the cwd stays";
+                };
+            };
+        };
+        readonly watch: {
+            readonly summary: "Keep a running feed live: sample it while it runs, push its DAG to every surface; none lists the watches";
+            readonly operands: readonly [{
+                readonly optional: true;
+                readonly name: "feed";
+                readonly kind: "word";
+                readonly summary: "The feed: feed_N or its id";
+            }];
+        };
+        readonly unwatch: {
+            readonly summary: "Release the watch on a feed";
+            readonly operands: readonly [{
+                readonly name: "feed";
+                readonly kind: "word";
+                readonly summary: "The feed: feed_N or its id";
+            }];
+        };
+    };
+}>;
+/**
+ * `proc` over words already split: the declaration's parse and handler.
+ *
+ * @param args - The words after `proc`.
+ * @returns An envelope carrying the subcommand's output, or the refusal of a bad line.
+ *
+ * @example
+ * ```ts
+ * await builtin_proc(['stat']);
+ * ```
  */
 export declare function builtin_proc(args: string[]): Promise<CommandEnvelope>;