@wirecat/cli-core 0.429.0 → 0.430.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -7,6 +7,12 @@ shape of this file.
7
7
 
8
8
  ## Unreleased
9
9
 
10
+ ## 0.430.0 — 25.10.2026
11
+
12
+ ### Added
13
+
14
+ - **Run records for a CLI with its own commander program** (`/cli`). `recordRuns(program, options)` gives a `startCli` tool WC-LIFE-15 in one call: `--record` and `--no-record`, a failed run for every failed command — a usage error before any action included, named by its command words and never an argument — and a run of every command when the flag or the saved `record` asks. `providerEvent(event)` and `providerRequest(operation)` put a provider call's operation, status and duration into the current command's run from anywhere in the program. `commandRuns(options)` keeps one command's run from a tool's own hooks under `run()`, and `runSettings(flag, saved)` is the rule both follow. zoom-cli, drive-cli and cli-memo replace their own copies with it. A run with no profile now leaves `profile` out rather than writing `""`.
15
+
10
16
  ## 0.429.0 — 25.10.2026
11
17
 
12
18
  ### Added
@@ -0,0 +1,64 @@
1
+ import { type RenderFormat, type Streams } from "@wirecat/cli-base";
2
+ import type { Command } from "commander";
3
+ import type { AppIdentity } from "../ports/app.js";
4
+ import type { RequestEvent } from "../runs/events.js";
5
+ /** What the owner saved: `record` and `keep_runs_for_days`, read from the CLI's own config. */
6
+ export interface SavedRunSettings {
7
+ record?: boolean | undefined;
8
+ keepRunsForDays?: number | undefined;
9
+ }
10
+ export interface RunSettings {
11
+ record: boolean;
12
+ keepFailedRuns: boolean;
13
+ keepRunsForDays: number;
14
+ }
15
+ /** `--record`/`--no-record` first, then the config; a failure is kept unless either says no (WC-LIFE-15). */
16
+ export declare const runSettings: (flag: boolean | undefined, saved?: SavedRunSettings) => RunSettings;
17
+ export interface CommandRunOptions {
18
+ app: AppIdentity;
19
+ /** The owner's saved choice. One that throws — a config that will not load — leaves the defaults. */
20
+ settings: () => SavedRunSettings;
21
+ /**
22
+ * The profile the command runs for; one that throws or is empty leaves the run without one. Given only by a CLI
23
+ * whose first word may be a profile, so a failure before any command skips that word when naming the run.
24
+ */
25
+ profile?: () => string | undefined;
26
+ /** An agent's run is named `mcp <command>`. Read from the program's environment when left out. */
27
+ agent?: boolean;
28
+ /** The data stream's format, which the warning about an unwritable run follows; `--json`/`--jsonl` when left out. */
29
+ format?: () => RenderFormat;
30
+ /** What a failed run keeps of the error: cli-memo turns a Commander or Valibot error into a CLI error first. */
31
+ recognise?: (error: unknown) => unknown;
32
+ env?: NodeJS.ProcessEnv;
33
+ streams?: Streams;
34
+ }
35
+ /** One command's run at a time, for a CLI that starts and ends it from its own hooks (zoom-cli under `run()`). */
36
+ export interface CommandRuns {
37
+ start(action: Command): void;
38
+ succeed(): Promise<void>;
39
+ fail(error: unknown): Promise<void>;
40
+ /** The id the command's run has, kept or not, so its answer can name it. */
41
+ runId(): string | undefined;
42
+ events(event: RequestEvent): void;
43
+ }
44
+ export declare const commandRuns: (options: CommandRunOptions) => CommandRuns;
45
+ /** For a provider client far from the program: the event lands in the current command's run, or nowhere. */
46
+ export declare const providerEvent: (event: RequestEvent) => void;
47
+ /**
48
+ * Times one provider call under a fixed operation name — nothing the call carries goes into the run. The returned
49
+ * function ends it; an `error` or an `errorCode` makes it a failed one.
50
+ */
51
+ export declare const providerRequest: (operation: string, sink?: (event: RequestEvent) => void) => ({ status, error, errorCode }?: {
52
+ status?: number;
53
+ error?: unknown;
54
+ errorCode?: string;
55
+ }) => void;
56
+ /**
57
+ * WC-LIFE-15 for a CLI with its own commander program (`startCli`, not `run()`): adds `--record` and `--no-record`,
58
+ * keeps every failed command as a run — a usage error before any action too — and every command when recording is
59
+ * on. Call it after the program's other `parseAsync` wrappers, so its own is the outermost and sees how the parse
60
+ * really ended; a refusal in an earlier `preAction` hook is then kept under the words read from the line.
61
+ */
62
+ export declare const recordRuns: (program: Command, options: CommandRunOptions & {
63
+ content: string;
64
+ }) => void;
@@ -0,0 +1,171 @@
1
+ import { AsyncLocalStorage } from "node:async_hooks";
2
+ import { isCliError } from "@wirecat/cli-base";
3
+ import { startRecording, wasSettled } from "../runs/recording.js";
4
+ import { KEEP_RUNS_FOR_DAYS } from "../runs/run.js";
5
+ import { environmentOf } from "./context.js";
6
+ /** `--record`/`--no-record` first, then the config; a failure is kept unless either says no (WC-LIFE-15). */
7
+ export const runSettings = (flag, saved = {}) => {
8
+ const record = flag ?? saved.record ?? false;
9
+ return {
10
+ record,
11
+ keepFailedRuns: record || (flag !== false && saved.record !== false),
12
+ keepRunsForDays: saved.keepRunsForDays ?? KEEP_RUNS_FOR_DAYS,
13
+ };
14
+ };
15
+ const SKIPPED = new Set(["runs", "help"]);
16
+ const pathOf = (command) => {
17
+ const words = [];
18
+ for (let at = command; at?.parent; at = at.parent)
19
+ words.unshift(at.name());
20
+ return words;
21
+ };
22
+ const tracker = (options) => {
23
+ let recording;
24
+ const open = (program, words, flag, format) => {
25
+ recording = undefined;
26
+ // Reading the log is not worth a run of its own.
27
+ if (SKIPPED.has(words[0] ?? ""))
28
+ return;
29
+ const environment = environmentOf(program);
30
+ let saved = {};
31
+ try {
32
+ saved = options.settings();
33
+ }
34
+ catch { }
35
+ let profile;
36
+ try {
37
+ profile = options.profile?.() || undefined;
38
+ }
39
+ catch { }
40
+ const settings = runSettings(flag, saved);
41
+ const agent = options.agent ?? environment.agent !== undefined;
42
+ const streams = options.streams ?? environment.streams;
43
+ const env = options.env ?? environment.env;
44
+ recording = startRecording({
45
+ app: options.app,
46
+ command: `${agent ? "mcp " : ""}${words.join(" ") || options.app.command}`,
47
+ ...(profile === undefined ? {} : { profile }),
48
+ record: settings.record,
49
+ keepFailed: settings.keepFailedRuns,
50
+ keepDays: settings.keepRunsForDays,
51
+ trace: false,
52
+ format,
53
+ ...(streams ? { streams } : {}),
54
+ ...(env ? { env } : {}),
55
+ });
56
+ };
57
+ const finish = () => {
58
+ const done = recording;
59
+ recording = undefined;
60
+ return done;
61
+ };
62
+ return {
63
+ start(action) {
64
+ const flags = action.optsWithGlobals();
65
+ const json = (flags.json !== undefined && flags.json !== false) || Boolean(flags.jsonl);
66
+ open(action, pathOf(action), flags.record, options.format?.() ?? (json ? "json" : "pretty"));
67
+ },
68
+ async succeed() {
69
+ await finish()?.succeed();
70
+ },
71
+ async fail(error) {
72
+ await finish()?.fail(options.recognise ? options.recognise(error) : error);
73
+ },
74
+ runId: () => recording?.runId,
75
+ events: (event) => recording?.events(event),
76
+ open,
77
+ };
78
+ };
79
+ export const commandRuns = (options) => tracker(options);
80
+ const parses = new AsyncLocalStorage();
81
+ /** For a provider client far from the program: the event lands in the current command's run, or nowhere. */
82
+ export const providerEvent = (event) => parses.getStore()?.runs.events(event);
83
+ /**
84
+ * Times one provider call under a fixed operation name — nothing the call carries goes into the run. The returned
85
+ * function ends it; an `error` or an `errorCode` makes it a failed one.
86
+ */
87
+ export const providerRequest = (operation, sink = providerEvent) => {
88
+ sink({ event: "request", operation });
89
+ const started = performance.now();
90
+ return ({ status, error, errorCode } = {}) => {
91
+ const failed = error !== undefined || errorCode !== undefined;
92
+ sink({
93
+ event: "response",
94
+ operation,
95
+ ...(status === undefined ? {} : { status }),
96
+ durationMs: Math.round(performance.now() - started),
97
+ outcome: failed ? "error" : "ok",
98
+ ...(failed ? { errorCode: errorCode ?? (isCliError(error) ? error.code : "provider_error") } : {}),
99
+ });
100
+ };
101
+ };
102
+ /** `files list` from `files list abc --limit 5`: command words only, never an argument. */
103
+ const pathFromArgs = (program, args, profileWord) => {
104
+ const words = [];
105
+ let at = program;
106
+ let skipped = !profileWord;
107
+ for (const arg of args) {
108
+ if (arg.startsWith("-"))
109
+ continue;
110
+ const next = at.commands.find((one) => one.name() === arg || one.aliases().includes(arg));
111
+ if (next) {
112
+ words.push(arg);
113
+ at = next;
114
+ }
115
+ else if (words.length === 0 && !skipped)
116
+ skipped = true;
117
+ else
118
+ break;
119
+ }
120
+ return words;
121
+ };
122
+ const isHelpExit = (error) => {
123
+ const { code, exitCode } = (error ?? {});
124
+ return typeof code === "string" && code.startsWith("commander.") && (exitCode === 0 || code === "commander.help");
125
+ };
126
+ /**
127
+ * WC-LIFE-15 for a CLI with its own commander program (`startCli`, not `run()`): adds `--record` and `--no-record`,
128
+ * keeps every failed command as a run — a usage error before any action too — and every command when recording is
129
+ * on. Call it after the program's other `parseAsync` wrappers, so its own is the outermost and sees how the parse
130
+ * really ended; a refusal in an earlier `preAction` hook is then kept under the words read from the line.
131
+ */
132
+ export const recordRuns = (program, options) => {
133
+ program
134
+ .option("--record", `keep this run — ids and timings, never ${options.content}`)
135
+ .option("--no-record", "do not keep this run, even if it fails");
136
+ program.hook("preAction", (_root, action) => {
137
+ const parse = parses.getStore();
138
+ if (!parse)
139
+ return;
140
+ parse.started = true;
141
+ parse.runs.start(action);
142
+ });
143
+ const parseAsync = program.parseAsync.bind(program);
144
+ program.parseAsync = (argv, settings) => {
145
+ const parse = { runs: tracker(options), started: false };
146
+ return parses.run(parse, async () => {
147
+ try {
148
+ const parsed = await parseAsync(argv, settings);
149
+ await parse.runs.succeed();
150
+ return parsed;
151
+ }
152
+ catch (error) {
153
+ if (!isHelpExit(error) && !wasSettled(error)) {
154
+ try {
155
+ if (!parse.started) {
156
+ const args = settings?.from === "user" ? (argv ?? []) : (argv ?? process.argv).slice(2);
157
+ const flag = args.includes("--no-record") ? false : args.includes("--record") ? true : undefined;
158
+ const json = args.some((arg) => arg === "--json" || arg.startsWith("--json=") || arg === "--jsonl");
159
+ const words = pathFromArgs(program, args, options.profile !== undefined);
160
+ const format = options.format?.() ?? (json ? "json" : "pretty");
161
+ parse.runs.open(program, words, flag, format);
162
+ }
163
+ await parse.runs.fail(error);
164
+ }
165
+ catch { }
166
+ }
167
+ throw error;
168
+ }
169
+ });
170
+ };
171
+ };
@@ -50,6 +50,7 @@ export { BotTokenStore, type BotTokenStoreOptions } from "./bot/token.js";
50
50
  export { PressLog, UpdatesCursor } from "./bot/updates.js";
51
51
  export type { CommandAvailability, DiscoveredCommand } from "./command-availability.js";
52
52
  export { commandContract, type JsonSchema, SCHEMA_DIALECT } from "./command-contract.js";
53
+ export { type CommandRunOptions, type CommandRuns, commandRuns, providerEvent, providerRequest, type RunSettings, recordRuns, runSettings, type SavedRunSettings, } from "./command-runs.js";
53
54
  export { CONTRACT } from "./commands-command.js";
54
55
  export { refuseUnknownKey } from "./config-command.js";
55
56
  export { type ConfigIssue, type ConfigIssueKind, checkConfigText, issueMessage } from "./config-issues.js";
package/dist/cli/index.js CHANGED
@@ -43,6 +43,7 @@ export { botFiles, botsDirectory, ChatRegistry, registryProfiles } from "./bot/r
43
43
  export { BotTokenStore } from "./bot/token.js";
44
44
  export { PressLog, UpdatesCursor } from "./bot/updates.js";
45
45
  export { commandContract, SCHEMA_DIALECT } from "./command-contract.js";
46
+ export { commandRuns, providerEvent, providerRequest, recordRuns, runSettings, } from "./command-runs.js";
46
47
  export { CONTRACT } from "./commands-command.js";
47
48
  export { refuseUnknownKey } from "./config-command.js";
48
49
  export { checkConfigText, issueMessage } from "./config-issues.js";
@@ -38,7 +38,6 @@ export declare const meetingTools: ({
38
38
  max_read_bytes?: undefined;
39
39
  cursor?: undefined;
40
40
  } | {
41
- limit?: undefined;
42
41
  event_id?: undefined;
43
42
  series_id?: undefined;
44
43
  page?: undefined;
@@ -54,11 +53,11 @@ export declare const meetingTools: ({
54
53
  format?: undefined;
55
54
  transcript_id?: undefined;
56
55
  query?: undefined;
56
+ limit?: undefined;
57
57
  scan_limit?: undefined;
58
58
  max_read_bytes?: undefined;
59
59
  cursor?: undefined;
60
60
  } | {
61
- limit?: undefined;
62
61
  event_id?: undefined;
63
62
  series_id?: undefined;
64
63
  page?: undefined;
@@ -76,11 +75,11 @@ export declare const meetingTools: ({
76
75
  format?: undefined;
77
76
  transcript_id?: undefined;
78
77
  query?: undefined;
78
+ limit?: undefined;
79
79
  scan_limit?: undefined;
80
80
  max_read_bytes?: undefined;
81
81
  cursor?: undefined;
82
82
  } | {
83
- limit?: undefined;
84
83
  event_id?: undefined;
85
84
  series_id?: undefined;
86
85
  page?: undefined;
@@ -102,6 +101,7 @@ export declare const meetingTools: ({
102
101
  minimum: number;
103
102
  };
104
103
  query?: undefined;
104
+ limit?: undefined;
105
105
  scan_limit?: undefined;
106
106
  max_read_bytes?: undefined;
107
107
  cursor?: undefined;
@@ -188,7 +188,6 @@ export declare const meetingTools: ({
188
188
  max_read_bytes?: undefined;
189
189
  cursor?: undefined;
190
190
  } | {
191
- limit?: undefined;
192
191
  event_id?: undefined;
193
192
  series_id?: undefined;
194
193
  page?: undefined;
@@ -204,11 +203,11 @@ export declare const meetingTools: ({
204
203
  format?: undefined;
205
204
  transcript_id?: undefined;
206
205
  query?: undefined;
206
+ limit?: undefined;
207
207
  scan_limit?: undefined;
208
208
  max_read_bytes?: undefined;
209
209
  cursor?: undefined;
210
210
  } | {
211
- limit?: undefined;
212
211
  event_id?: undefined;
213
212
  series_id?: undefined;
214
213
  page?: undefined;
@@ -226,11 +225,11 @@ export declare const meetingTools: ({
226
225
  format?: undefined;
227
226
  transcript_id?: undefined;
228
227
  query?: undefined;
228
+ limit?: undefined;
229
229
  scan_limit?: undefined;
230
230
  max_read_bytes?: undefined;
231
231
  cursor?: undefined;
232
232
  } | {
233
- limit?: undefined;
234
233
  event_id?: undefined;
235
234
  series_id?: undefined;
236
235
  page?: undefined;
@@ -252,6 +251,7 @@ export declare const meetingTools: ({
252
251
  minimum: number;
253
252
  };
254
253
  query?: undefined;
254
+ limit?: undefined;
255
255
  scan_limit?: undefined;
256
256
  max_read_bytes?: undefined;
257
257
  cursor?: undefined;
@@ -338,7 +338,6 @@ export declare const meetingTools: ({
338
338
  max_read_bytes?: undefined;
339
339
  cursor?: undefined;
340
340
  } | {
341
- limit?: undefined;
342
341
  event_id?: undefined;
343
342
  series_id?: undefined;
344
343
  page?: undefined;
@@ -354,11 +353,11 @@ export declare const meetingTools: ({
354
353
  format?: undefined;
355
354
  transcript_id?: undefined;
356
355
  query?: undefined;
356
+ limit?: undefined;
357
357
  scan_limit?: undefined;
358
358
  max_read_bytes?: undefined;
359
359
  cursor?: undefined;
360
360
  } | {
361
- limit?: undefined;
362
361
  event_id?: undefined;
363
362
  series_id?: undefined;
364
363
  page?: undefined;
@@ -376,11 +375,11 @@ export declare const meetingTools: ({
376
375
  format?: undefined;
377
376
  transcript_id?: undefined;
378
377
  query?: undefined;
378
+ limit?: undefined;
379
379
  scan_limit?: undefined;
380
380
  max_read_bytes?: undefined;
381
381
  cursor?: undefined;
382
382
  } | {
383
- limit?: undefined;
384
383
  event_id?: undefined;
385
384
  series_id?: undefined;
386
385
  page?: undefined;
@@ -402,6 +401,7 @@ export declare const meetingTools: ({
402
401
  minimum: number;
403
402
  };
404
403
  query?: undefined;
404
+ limit?: undefined;
405
405
  scan_limit?: undefined;
406
406
  max_read_bytes?: undefined;
407
407
  cursor?: undefined;
@@ -488,7 +488,6 @@ export declare const meetingTools: ({
488
488
  max_read_bytes?: undefined;
489
489
  cursor?: undefined;
490
490
  } | {
491
- limit?: undefined;
492
491
  event_id?: undefined;
493
492
  series_id?: undefined;
494
493
  page?: undefined;
@@ -504,11 +503,11 @@ export declare const meetingTools: ({
504
503
  format?: undefined;
505
504
  transcript_id?: undefined;
506
505
  query?: undefined;
506
+ limit?: undefined;
507
507
  scan_limit?: undefined;
508
508
  max_read_bytes?: undefined;
509
509
  cursor?: undefined;
510
510
  } | {
511
- limit?: undefined;
512
511
  event_id?: undefined;
513
512
  series_id?: undefined;
514
513
  page?: undefined;
@@ -526,11 +525,11 @@ export declare const meetingTools: ({
526
525
  format?: undefined;
527
526
  transcript_id?: undefined;
528
527
  query?: undefined;
528
+ limit?: undefined;
529
529
  scan_limit?: undefined;
530
530
  max_read_bytes?: undefined;
531
531
  cursor?: undefined;
532
532
  } | {
533
- limit?: undefined;
534
533
  event_id?: undefined;
535
534
  series_id?: undefined;
536
535
  page?: undefined;
@@ -552,6 +551,7 @@ export declare const meetingTools: ({
552
551
  minimum: number;
553
552
  };
554
553
  query?: undefined;
554
+ limit?: undefined;
555
555
  scan_limit?: undefined;
556
556
  max_read_bytes?: undefined;
557
557
  cursor?: undefined;
@@ -638,7 +638,6 @@ export declare const meetingTools: ({
638
638
  max_read_bytes?: undefined;
639
639
  cursor?: undefined;
640
640
  } | {
641
- limit?: undefined;
642
641
  event_id?: undefined;
643
642
  series_id?: undefined;
644
643
  page?: undefined;
@@ -654,11 +653,11 @@ export declare const meetingTools: ({
654
653
  format?: undefined;
655
654
  transcript_id?: undefined;
656
655
  query?: undefined;
656
+ limit?: undefined;
657
657
  scan_limit?: undefined;
658
658
  max_read_bytes?: undefined;
659
659
  cursor?: undefined;
660
660
  } | {
661
- limit?: undefined;
662
661
  event_id?: undefined;
663
662
  series_id?: undefined;
664
663
  page?: undefined;
@@ -676,11 +675,11 @@ export declare const meetingTools: ({
676
675
  format?: undefined;
677
676
  transcript_id?: undefined;
678
677
  query?: undefined;
678
+ limit?: undefined;
679
679
  scan_limit?: undefined;
680
680
  max_read_bytes?: undefined;
681
681
  cursor?: undefined;
682
682
  } | {
683
- limit?: undefined;
684
683
  event_id?: undefined;
685
684
  series_id?: undefined;
686
685
  page?: undefined;
@@ -702,6 +701,7 @@ export declare const meetingTools: ({
702
701
  minimum: number;
703
702
  };
704
703
  query?: undefined;
704
+ limit?: undefined;
705
705
  scan_limit?: undefined;
706
706
  max_read_bytes?: undefined;
707
707
  cursor?: undefined;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wirecat/cli-core",
3
- "version": "0.429.0",
3
+ "version": "0.430.0",
4
4
  "description": "The messenger-neutral half of a messaging CLI: domain model, message locators, rendering, name resolution, the SQLite seam, the command skeleton and shared read commands, the send guard, run records and the message store",
5
5
  "license": "Apache-2.0",
6
6
  "author": "Viacheslav Ptsarev",