@duyquangnvx/agent-cli 0.4.0 → 0.6.0

package/dist/define.d.ts

@@ -1,82 +1,16 @@
 import type * as z from "zod";
-import type { Clock } from "./clock.js";
+import type { BuildStamp, Context, PortsBase, ProjectFile } from "./context.js";
 import type { ErrorTable } from "./error-table.js";
-import type { Files } from "./files.js";
 import { type StandardFlagName } from "./flags.js";
 import type { Page, PageInput, RowSchema } from "./list.js";
-import type { Secret } from "./secrets.js";
-import type { ContextSpawn } from "./spawn.js";
+import type { SideTaskRun } from "./side-task.js";
 import type { Style } from "./style.js";
-export type Env = Readonly<Record<string, string | undefined>>;
+/** Shown in help and help JSON. */
 export interface Example {
+    /** A realistic full command line, starting with the CLI's name. */
     readonly command: string;
     readonly note: string;
 }
-export interface PollOptions {
-    readonly intervalMs: number;
-}
-export interface Context<Ports = unknown, Settings = unknown> {
-    readonly cwd: string;
-    readonly env: Env;
-    /** The folder holding this CLI's `package.json`, for reading files shipped in the package. */
-    readonly packageRoot: string;
-    /** Writes a plain line to stderr, for long work; it never reaches stdout. */
-    progress(message: string): void;
-    /**
-     * Aborts when the run is interrupted (Ctrl-C) or hits the Command's run deadline; pass it to
-     * `fetch` and child processes.
-     */
-    readonly signal: AbortSignal;
-    /** Returns a signal that also aborts, with `DEADLINE_EXCEEDED`, once `ms` have passed. */
-    deadline(ms: number): AbortSignal;
-    /**
-     * Runs a step that must not stop halfway: the run waits for it even when stopped, and then
-     * prints `finishing <name>` on stderr.
-     */
-    runToEnd<T>(name: string, work: () => Promise<T>): Promise<T>;
-    /**
-     * Records the data done so far, in the shape `render` takes; the last call wins. A run that then
-     * fails, hits a deadline or is interrupted prints it; a returned value replaces it.
-     */
-    deliver(data: unknown): void;
-    /** The outside systems the CLI declared with `agentCli<Ports>()`. */
-    readonly ports: Ports;
-    /**
-     * Reads, lists, removes and atomically writes files and folders, paths resolved against `cwd`; a
-     * failure fails the run with `PERMISSION_DENIED`, `DISK_FULL`, `NOT_FOUND` or `ALREADY_EXISTS`.
-     */
-    readonly files: Files;
-    /**
-     * Runs a child process, killed when the run is interrupted; `check: true` fails the run with
-     * `TOOL_FAILED` and the tail of its stderr when it exits non-zero.
-     */
-    readonly spawn: ContextSpawn;
-    /** Deadlines, `poll` and the grace period after an interrupt run on it. */
-    readonly clock: Clock;
-    /**
-     * Calls `check` until it returns a value other than `undefined`, sleeping `intervalMs` between
-     * calls; it stops when `ctx.signal` aborts.
-     */
-    poll<T>(check: () => T | undefined | Promise<T | undefined>, options: PollOptions): Promise<T>;
-    /** The Project file found by walking up from `cwd`, parsed by the CLI's schema. */
-    readonly project: Project<Settings> | undefined;
-    /** Reads `name` from the env, then from `$XDG_CONFIG_HOME/<cli>/.env`, with where it came from. */
-    secret(name: string): Secret | undefined;
-    /** Whether the caller passed `--force`; always false for a Command without it. */
-    readonly force: boolean;
-}
-/** The slice of `Context` the ports factory receives, which exists before the ports do. */
-export type PortsBase = Pick<Context, "env" | "cwd" | "packageRoot" | "secret" | "spawn" | "files" | "clock" | "signal">;
-export interface Project<Settings = unknown> {
-    /** The folder holding the Project file. */
-    readonly root: string;
-    readonly settings: Settings;
-}
-/** Names the Project file and the schema its JSON must match. */
-export interface ProjectFile<Settings = unknown> {
-    readonly file: string;
-    readonly schema: z.ZodType<Settings>;
-}
 export type InputSchema = z.ZodObject;
 export type NoPorts = Record<never, never>;
 export type NoInput = z.ZodObject<Record<never, never>>;
@@ -94,52 +28,103 @@ export interface Tool {
 /** Bounds a whole run, so a long run stops before the caller's own timeout and can be continued. */
 export interface RunDeadline<In> {
     readonly ms: number;
-    /** The command line that continues the work, given as the hint of the run's `DEADLINE_EXCEEDED`. */
-    resume(input: In): string;
+    /**
+     * The command line that continues the work, given as the hint of the run's `DEADLINE_EXCEEDED`;
+     * `commandLine` is `ctx.commandLine`. Once the deadline passes, every error of the run becomes
+     * `DEADLINE_EXCEEDED`.
+     */
+    resume(input: In, commandLine: Context["commandLine"]): string;
 }
 interface CommandBase<Args extends InputSchema, Options extends InputSchema> {
+    /** The word the Command is listed under in `commands`; it labels the Command in errors and spill files. */
     readonly name: string;
+    /** One line, shown in help and help JSON. */
     readonly description: string;
+    /** A paragraph printed after the options in text help, and carried as `help` in help JSON. */
+    readonly help?: string;
     readonly examples: readonly Example[];
-    /** Missing ones fail the run with `TOOL_MISSING` before `plan`, `run` or `start`. */
+    /** Left out of help, help JSON, the root examples and suggestions, but still routed and run. */
+    readonly hidden?: boolean;
+    /**
+     * Only a person at a terminal runs it: under a Coding agent the run fails with `NEEDS_OPERATOR`
+     * (exit 2) before its input is read, stdin included, and the hint asks the operator to type the
+     * command line after `!`. `--json` alone does not make it refuse.
+     */
+    readonly operator?: true;
+    /**
+     * Looked up before `plan`, `run` or `start`, `--dry-run` included: missing ones fail the run with
+     * `TOOL_MISSING` (exit 2), naming each with its `install`, and `doctor` checks each.
+     */
     readonly tools?: readonly Tool[];
+    /**
+     * Positional operands, in the schema's order; each field's `.describe()` is its help. The last
+     * field may be a `z.array(...)`, which takes every remaining operand, and one string field may be
+     * wrapped in `orStdin`. Input the schema rejects is a usage error (exit 1) before the Command runs.
+     */
     readonly args?: Args;
+    /**
+     * Flags, a camelCase key typed in kebab-case; each field's `.describe()` is its help. A
+     * `z.array(...)` option collects every occurrence of its flag in order, and a repeated scalar flag
+     * keeps its last value. Input the schema rejects is a usage error (exit 1) before the Command runs.
+     */
     readonly options?: Options;
     /** At `ms`, `ctx.signal` aborts and the run ends with `DEADLINE_EXCEEDED` (exit 75). */
     readonly deadline?: RunDeadline<Input<Args, Options>>;
 }
 interface UnpagedCommand<Args extends InputSchema, Options extends InputSchema> extends CommandBase<Args, Options> {
+    /** The schema of the data the Command prints, published as JSON Schema in help JSON. */
     readonly output?: z.ZodType;
     readonly rows?: never;
 }
 export interface ReadCommand<Args extends InputSchema, Options extends InputSchema, Data, Ports = unknown, Settings = unknown> extends UnpagedCommand<Args, Options> {
     readonly effect: "read";
     run(input: Input<Args, Options>, ctx: Context<Ports, Settings>): Data | Promise<Data>;
+    /**
+     * Turns the data into short text; `--json` prints the data itself. `style` colours only when a
+     * person watches a terminal or `FORCE_COLOR` is set.
+     */
     render(data: Data, style: Style): string;
 }
-/** A read Command whose data is a page of rows; the Runtime adds `--limit`, `--cursor` and `--fields`. */
+/**
+ * A read Command whose data is a page of rows, from `paginate` or `page`; the Runtime adds `--limit`
+ * (default 20), `--cursor` and `--fields`, and prints the page as `{ items, next? }`, `next` being
+ * the command line for the following page, and as text ends it with a line saying how many rows were
+ * shown and either that command line or that no pages remain. A page never spills, and `--fields` keeps only the named fields.
+ */
 export interface ListCommand<Args extends InputSchema, Options extends InputSchema, Row extends RowSchema, Ports = unknown, Settings = unknown> extends CommandBase<Args, Options> {
     readonly effect: "read";
     /** The schema of one row; the page's output schema is derived from it. */
     readonly rows: Row;
     readonly output?: never;
     run(input: Flatten<OutputOf<Args> & OutputOf<Options> & PageInput>, ctx: Context<Ports, Settings>): Page<z.output<Row>> | Promise<Page<z.output<Row>>>;
+    /** Receives the page; render `page.items`. */
     render(page: Page<z.output<Row>>, style: Style): string;
 }
-/** A Command that changes something: `plan` has no side effects, `apply` performs the Plan. */
+/**
+ * A Command that changes something: `plan` has no side effects, `apply` performs the Plan. The
+ * Runtime adds `--dry-run`, which prints the Plan and stops; between `plan` and `apply` it checks
+ * `outputs`, then `cost`, then `confirm`, each refusal's hint holding the command line plus its flag.
+ */
 interface PlannedCommand<Args extends InputSchema, Options extends InputSchema, Plan, Data, Ports, Settings> extends UnpagedCommand<Args, Options> {
     plan(input: Input<Args, Options>, ctx: Context<Ports, Settings>): Plan | Promise<Plan>;
     apply(plan: Plan, ctx: Context<Ports, Settings>): Data | Promise<Data>;
     render(data: Data, style: Style): string;
+    /**
+     * `--dry-run --json` prints the Plan itself, or `{ plan, outputs?, cost }` when the Command
+     * declares `outputs` or `cost`; a byte array in it prints as an index-keyed object.
+     */
     renderPlan(plan: Plan, style: Style): string;
     /**
      * A sentence stating what the Plan costs, or undefined when it is cheap. Declaring it adds
-     * `--yes`, which a run must pass whenever it returns a sentence.
+     * `--yes`; a run whose cost is a sentence and lacks it refuses with `NOT_CONFIRMED` (exit 2), and
+     * `--dry-run` prints `cost: <sentence>`.
      */
     cost?(plan: Plan): string | undefined;
     /**
      * The files the Plan writes, relative to `ctx.cwd`. Declaring it adds `--force`, without which
-     * a run refuses with `OUTPUT_EXISTS` when any of them exists.
+     * a run refuses with `OUTPUT_EXISTS` (exit 1) when any of them exists, and `--dry-run` lists them.
+     * Before `apply` the Runtime creates each one's folder and a temp file in it, so a sandbox denial
+     * fails with `PERMISSION_DENIED` first; without `--force` the first write to each is exclusive.
      */
     outputs?(plan: Plan): readonly string[];
     /**
@@ -153,10 +138,16 @@ export interface WriteCommand<Args extends InputSchema, Options extends InputSch
 }
 export interface DestructiveCommand<Args extends InputSchema, Options extends InputSchema, Plan, Data, Ports = unknown, Settings = unknown> extends PlannedCommand<Args, Options, Plan, Data, Ports, Settings> {
     readonly effect: "destructive";
-    /** The value the caller must repeat as `--confirm`, naming the target the Plan changes. */
+    /**
+     * The value the caller must repeat as `--confirm`, naming the target the Plan changes; without it
+     * the run refuses with exit 1.
+     */
     confirm(plan: Plan): string;
 }
-/** A Command that keeps running, such as a preview server, until Ctrl-C or SIGTERM stops it. */
+/**
+ * A Command that keeps running, such as a preview server, until Ctrl-C or SIGTERM stops it with
+ * exit 0. Of the Standard flags it gets only `--json`.
+ */
 export interface ServeCommand<Args extends InputSchema, Options extends InputSchema, Data, Ports = unknown, Settings = unknown> extends UnpagedCommand<Args, Options> {
     readonly effect: "serve";
     /** Starts the work and returns its data, which prints at once; stop the work on `ctx.signal`. */
@@ -170,17 +161,27 @@ export interface Commands<Ports = unknown, Settings = unknown> {
 interface CliBase<Ports, Settings> {
     readonly name: string;
     readonly version: string;
+    /** One line saying what the CLI does, shown under the first line of its help and in help JSON. */
+    readonly description: string;
     /** The commit the build was made from and when, stamped by the bundler; `--version` prints it. */
-    readonly build?: {
-        readonly sha: string;
-        readonly dirty: boolean;
-        readonly builtAt: string;
-    };
+    readonly build?: BuildStamp;
     /** Every code the CLI throws; a code missing here exits 70, as a bug. */
     readonly errors?: ErrorTable;
     /** Builds the real ports when a run first reads `ctx.ports`; `runCli`'s `ports` replaces them in a test. */
     readonly ports?: (base: PortsBase) => Ports;
     readonly project?: ProjectFile<Settings>;
+    /** Where `npx skills add` installs the CLI's skill from; read from package.json `repository` when absent. */
+    readonly skill?: {
+        readonly source: string;
+    };
+    /**
+     * Work that runs beside every Command run, such as a usage count; return `undefined` to decline.
+     * It starts once the input is parsed, before `plan`, `run` or `start`, so it also runs for a run a
+     * guard refuses, and once the output is written the run waits for it at most `SIDE_TASK_WAIT_MS`.
+     * Nothing it throws changes stdout, stderr or the exit code; `<NAME>_DEBUG=1` prints it on stderr.
+     * It never runs for help, `--version`, a usage error or a built-in Command.
+     */
+    sideTask?(run: SideTaskRun<Ports>): Promise<void> | undefined;
 }
 /** Where an Agent CLI is published and how it is installed; `doctor` and `update` read it. */
 export interface GlobalInstall {
@@ -188,12 +189,22 @@ export interface GlobalInstall {
     readonly package: string;
     readonly registry: string;
 }
-export interface DoctorFinding {
-    readonly state: "ok" | "problem";
+/** What a `doctor` row found. A skipped row was not checked, and never fails `doctor`. */
+export type DoctorFinding = {
+    readonly state: "ok";
+    readonly message: string;
+    readonly fix?: string;
+} | {
+    readonly state: "problem";
     readonly message: string;
     /** The command that fixes the problem. */
     readonly fix?: string;
-}
+    /** A code of the Error table or the Runtime's that `doctor` fails with; `DOCTOR_PROBLEMS` when absent. */
+    readonly code?: string;
+} | {
+    readonly state: "skipped";
+    readonly message: string;
+};
 /** A row the CLI adds to `doctor`, for a system it depends on. */
 export interface DoctorCheck<Ports = unknown, Settings = unknown> {
     readonly name: string;
@@ -215,6 +226,8 @@ export interface CommandTreeCli<Ports = unknown, Settings = unknown> extends Cli
         readonly node?: string;
     };
     readonly doctor?: readonly DoctorCheck<Ports, Settings>[];
+    /** Tools `doctor` checks besides the Commands' own; no Command requires them. */
+    readonly tools?: readonly Tool[];
 }
 /** An Agent CLI that is one Command, run with no Command name, as in `tool <args>`. */
 export interface SingleCommandCli<Ports = unknown, Settings = unknown> extends CliBase<Ports, Settings> {

package/dist/define.js

@@ -1,9 +1,11 @@
 import { checkForce, checkNoStandardFlags } from "./flags.js";
-import { checkArrayArgLast } from "./input.js";
+import { checkArrayArgLast, checkNoBooleanArrayOption, checkStdinFields } from "./input.js";
 function checkedCommand(command) {
     checkNoStandardFlags(command);
     checkForce(command);
     checkArrayArgLast(command.name, command.args);
+    checkStdinFields(command.name, command.args, command.options);
+    checkNoBooleanArrayOption(command.name, command.options);
     return command;
 }
 export function defineCommandFor() {

package/dist/define.js.map

@@ -1 +1 @@
-{"version":3,"file":"define.js","sourceRoot":"","sources":["../src/define.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,UAAU,EAAE,oBAAoB,EAAyB,MAAM,YAAY,CAAC;AACrF,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AA+V/C,SAAS,cAAc,CAA2B,OAAiB;IACjE,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAC9B,UAAU,CAAC,OAAO,CAAC,CAAC;IACpB,iBAAiB,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9C,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,UAAU,gBAAgB;IAC9B,OAAO,cAAc,CAAC;AACxB,CAAC;AAED,MAAM,CAAC,MAAM,aAAa,GAA2B,gBAAgB,EAAE,CAAC;AAExE,0FAA0F;AAC1F,MAAM,UAAU,SAAS,CAAC,IAAwB;IAChD,OAAO,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ,CAAC;AACzC,CAAC"}
+{"version":3,"file":"define.js","sourceRoot":"","sources":["../src/define.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,UAAU,EAAE,oBAAoB,EAAyB,MAAM,YAAY,CAAC;AACrF,OAAO,EAAE,iBAAiB,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAkW5F,SAAS,cAAc,CAA2B,OAAiB;IACjE,oBAAoB,CAAC,OAAO,CAAC,CAAC;IAC9B,UAAU,CAAC,OAAO,CAAC,CAAC;IACpB,iBAAiB,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9C,gBAAgB,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IAC9D,yBAAyB,CAAC,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IACzD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,UAAU,gBAAgB;IAC9B,OAAO,cAAc,CAAC;AACxB,CAAC;AAED,MAAM,CAAC,MAAM,aAAa,GAA2B,gBAAgB,EAAE,CAAC;AAExE,0FAA0F;AAC1F,MAAM,UAAU,SAAS,CAAC,IAAwB;IAChD,OAAO,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ,CAAC;AACzC,CAAC"}

package/dist/errno.d.ts

@@ -1,15 +1,19 @@
-import type { Env } from "./define.js";
+import type { Env } from "./context.js";
 export declare const PERMISSION_DENIED = "PERMISSION_DENIED";
 export declare const DISK_FULL = "DISK_FULL";
 export declare const NOT_FOUND = "NOT_FOUND";
 export declare const ALREADY_EXISTS = "ALREADY_EXISTS";
-export interface ErrnoContext {
+export declare const NOT_A_FILE = "NOT_A_FILE";
+export interface FileAccess {
     readonly path: string;
     /** Whether the failed access read `path` or wrote it; a sandbox grants the two separately. */
     readonly access: "read" | "write";
+}
+export type FileError = (error: unknown, at: FileAccess) => unknown;
+export interface ErrnoScope {
     /** The caller's command line, ready to paste. */
     readonly callerLine: string;
     readonly env: Env;
+    readonly platform: NodeJS.Platform;
 }
-/** The error a file system failure on `path` stands for; any other error comes back unchanged. */
-export declare function classifyErrno(error: unknown, context: ErrnoContext): unknown;
+export declare function fileErrorOf(scope: ErrnoScope): FileError;

package/dist/errno.js

@@ -4,9 +4,13 @@ export const PERMISSION_DENIED = "PERMISSION_DENIED";
 export const DISK_FULL = "DISK_FULL";
 export const NOT_FOUND = "NOT_FOUND";
 export const ALREADY_EXISTS = "ALREADY_EXISTS";
+export const NOT_A_FILE = "NOT_A_FILE";
 // The same errnos happen with no sandbox at all (a root-owned folder), so only a detected agent is
-// pointed at its sandbox.
-function permissionHint({ path, access, callerLine, env }) {
+// pointed at its sandbox. Native Windows has no such sandbox: there a program holding the file denies it.
+function permissionHint({ path, access, callerLine, env, platform }) {
+    if (platform === "win32") {
+        return `a program may hold ${path} open: close it, then run the same command again`;
+    }
     if (!isAgent(env))
         return `check the permissions of ${path} and its folder`;
     const allow = access === "read"
@@ -14,24 +18,31 @@ function permissionHint({ path, access, callerLine, env }) {
         : `to allow ${path} in the sandbox's write list`;
     return `your sandbox may block it: ask your user to run \`! ${callerLine}\`, or ${allow}`;
 }
-/** The error a file system failure on `path` stands for; any other error comes back unchanged. */
-export function classifyErrno(error, context) {
+export function fileErrorOf(scope) {
+    return (error, at) => classifyErrno(error, { ...at, ...scope });
+}
+function classifyErrno(error, context) {
     const { path } = context;
     switch (errnoOf(error)) {
         case "EACCES":
         case "EPERM":
+        case "EROFS":
+        case "EBUSY":
             return new CliError({
                 code: PERMISSION_DENIED,
                 message: `permission denied: ${path}`,
                 hint: permissionHint(context),
             }, { cause: error });
         case "ENOSPC":
+        case "EDQUOT":
             return new CliError({
                 code: DISK_FULL,
                 message: `no space left on the disk holding ${path}`,
                 hint: "free space on that disk, then run the same command again",
             }, { cause: error });
         case "ENOENT":
+        case "ENOTDIR":
+        case "ENAMETOOLONG":
             return new CliError({
                 code: NOT_FOUND,
                 message: `not found: ${path}`,
@@ -43,6 +54,12 @@ export function classifyErrno(error, context) {
                 message: `already exists: ${path}`,
                 hint: `pass another path, or remove ${path}`,
             }, { cause: error });
+        case "EISDIR":
+            return new CliError({
+                code: NOT_A_FILE,
+                message: `not a file: ${path} is a folder`,
+                hint: `pass the path of a file, not of the folder ${path}`,
+            }, { cause: error });
         default:
             return error;
     }

package/dist/errno.js.map

@@ -1 +1 @@
-{"version":3,"file":"errno.js","sourceRoot":"","sources":["../src/errno.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAEhD,MAAM,CAAC,MAAM,iBAAiB,GAAG,mBAAmB,CAAC;AACrD,MAAM,CAAC,MAAM,SAAS,GAAG,WAAW,CAAC;AACrC,MAAM,CAAC,MAAM,SAAS,GAAG,WAAW,CAAC;AACrC,MAAM,CAAC,MAAM,cAAc,GAAG,gBAAgB,CAAC;AAW/C,mGAAmG;AACnG,0BAA0B;AAC1B,SAAS,cAAc,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,EAAgB;IACrE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC;QAAE,OAAO,4BAA4B,IAAI,iBAAiB,CAAC;IAC5E,MAAM,KAAK,GACT,MAAM,KAAK,MAAM;QACf,CAAC,CAAC,oBAAoB,IAAI,iBAAiB;QAC3C,CAAC,CAAC,YAAY,IAAI,8BAA8B,CAAC;IACrD,OAAO,uDAAuD,UAAU,UAAU,KAAK,EAAE,CAAC;AAC5F,CAAC;AAED,kGAAkG;AAClG,MAAM,UAAU,aAAa,CAAC,KAAc,EAAE,OAAqB;IACjE,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IACzB,QAAQ,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACvB,KAAK,QAAQ,CAAC;QACd,KAAK,OAAO;YACV,OAAO,IAAI,QAAQ,CACjB;gBACE,IAAI,EAAE,iBAAiB;gBACvB,OAAO,EAAE,sBAAsB,IAAI,EAAE;gBACrC,IAAI,EAAE,cAAc,CAAC,OAAO,CAAC;aAC9B,EACD,EAAE,KAAK,EAAE,KAAK,EAAE,CACjB,CAAC;QACJ,KAAK,QAAQ;YACX,OAAO,IAAI,QAAQ,CACjB;gBACE,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,qCAAqC,IAAI,EAAE;gBACpD,IAAI,EAAE,0DAA0D;aACjE,EACD,EAAE,KAAK,EAAE,KAAK,EAAE,CACjB,CAAC;QACJ,KAAK,QAAQ;YACX,OAAO,IAAI,QAAQ,CACjB;gBACE,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,cAAc,IAAI,EAAE;gBAC7B,IAAI,EAAE,cAAc,IAAI,uBAAuB;aAChD,EACD,EAAE,KAAK,EAAE,KAAK,EAAE,CACjB,CAAC;QACJ,KAAK,QAAQ;YACX,OAAO,IAAI,QAAQ,CACjB;gBACE,IAAI,EAAE,cAAc;gBACpB,OAAO,EAAE,mBAAmB,IAAI,EAAE;gBAClC,IAAI,EAAE,gCAAgC,IAAI,EAAE;aAC7C,EACD,EAAE,KAAK,EAAE,KAAK,EAAE,CACjB,CAAC;QACJ;YACE,OAAO,KAAK,CAAC;IACjB,CAAC;AACH,CAAC"}
+{"version":3,"file":"errno.js","sourceRoot":"","sources":["../src/errno.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAErC,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,aAAa,CAAC;AAEhD,MAAM,CAAC,MAAM,iBAAiB,GAAG,mBAAmB,CAAC;AACrD,MAAM,CAAC,MAAM,SAAS,GAAG,WAAW,CAAC;AACrC,MAAM,CAAC,MAAM,SAAS,GAAG,WAAW,CAAC;AACrC,MAAM,CAAC,MAAM,cAAc,GAAG,gBAAgB,CAAC;AAC/C,MAAM,CAAC,MAAM,UAAU,GAAG,YAAY,CAAC;AAmBvC,mGAAmG;AACnG,0GAA0G;AAC1G,SAAS,cAAc,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,QAAQ,EAAgB;IAC/E,IAAI,QAAQ,KAAK,OAAO,EAAE,CAAC;QACzB,OAAO,sBAAsB,IAAI,kDAAkD,CAAC;IACtF,CAAC;IACD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC;QAAE,OAAO,4BAA4B,IAAI,iBAAiB,CAAC;IAC5E,MAAM,KAAK,GACT,MAAM,KAAK,MAAM;QACf,CAAC,CAAC,oBAAoB,IAAI,iBAAiB;QAC3C,CAAC,CAAC,YAAY,IAAI,8BAA8B,CAAC;IACrD,OAAO,uDAAuD,UAAU,UAAU,KAAK,EAAE,CAAC;AAC5F,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,KAAiB;IAC3C,OAAO,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE,CAAC,aAAa,CAAC,KAAK,EAAE,EAAE,GAAG,EAAE,EAAE,GAAG,KAAK,EAAE,CAAC,CAAC;AAClE,CAAC;AAED,SAAS,aAAa,CAAC,KAAc,EAAE,OAAqB;IAC1D,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IACzB,QAAQ,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACvB,KAAK,QAAQ,CAAC;QACd,KAAK,OAAO,CAAC;QACb,KAAK,OAAO,CAAC;QACb,KAAK,OAAO;YACV,OAAO,IAAI,QAAQ,CACjB;gBACE,IAAI,EAAE,iBAAiB;gBACvB,OAAO,EAAE,sBAAsB,IAAI,EAAE;gBACrC,IAAI,EAAE,cAAc,CAAC,OAAO,CAAC;aAC9B,EACD,EAAE,KAAK,EAAE,KAAK,EAAE,CACjB,CAAC;QACJ,KAAK,QAAQ,CAAC;QACd,KAAK,QAAQ;YACX,OAAO,IAAI,QAAQ,CACjB;gBACE,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,qCAAqC,IAAI,EAAE;gBACpD,IAAI,EAAE,0DAA0D;aACjE,EACD,EAAE,KAAK,EAAE,KAAK,EAAE,CACjB,CAAC;QACJ,KAAK,QAAQ,CAAC;QACd,KAAK,SAAS,CAAC;QACf,KAAK,cAAc;YACjB,OAAO,IAAI,QAAQ,CACjB;gBACE,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,cAAc,IAAI,EAAE;gBAC7B,IAAI,EAAE,cAAc,IAAI,uBAAuB;aAChD,EACD,EAAE,KAAK,EAAE,KAAK,EAAE,CACjB,CAAC;QACJ,KAAK,QAAQ;YACX,OAAO,IAAI,QAAQ,CACjB;gBACE,IAAI,EAAE,cAAc;gBACpB,OAAO,EAAE,mBAAmB,IAAI,EAAE;gBAClC,IAAI,EAAE,gCAAgC,IAAI,EAAE;aAC7C,EACD,EAAE,KAAK,EAAE,KAAK,EAAE,CACjB,CAAC;QACJ,KAAK,QAAQ;YACX,OAAO,IAAI,QAAQ,CACjB;gBACE,IAAI,EAAE,UAAU;gBAChB,OAAO,EAAE,eAAe,IAAI,cAAc;gBAC1C,IAAI,EAAE,8CAA8C,IAAI,EAAE;aAC3D,EACD,EAAE,KAAK,EAAE,KAAK,EAAE,CACjB,CAAC;QACJ;YACE,OAAO,KAAK,CAAC;IACjB,CAAC;AACH,CAAC"}

package/dist/error-table.d.ts

@@ -4,6 +4,7 @@ import type { ExitClass } from "./exit-classes.js";
 /** The Exit classes a CLI's own code can have; a bug or an interrupt is the Runtime's to tell. */
 export type DeclaredExitClass = Exclude<ExitClass, "bug" | "interrupted">;
 export interface ErrorDeclaration {
+    /** Who must act, which sets the exit code: `caller` 1, `operator` 2, `source` 3, `wait` 75. */
     readonly class: DeclaredExitClass;
     readonly details?: z.ZodType;
 }
@@ -29,6 +30,10 @@ export type CliErrorInit<Declaration extends ErrorDeclaration> = {
     readonly message: string;
     readonly hint: string;
 } & DetailsInit<Declaration> & RetryInit<Declaration>;
-/** A `CliError` for a code of `table`, whose `details` must match the code's schema. */
+/**
+ * A `CliError` for a code of `table`, whose `details` must match the code's schema. The `hint`
+ * names the next command to run and says whether running it again can help; `retryAt` (ISO 8601)
+ * is allowed only on a wait-class code.
+ */
 export declare function cliError<Table extends ErrorTable, Code extends keyof Table & string>(_table: Table, code: Code, init: CliErrorInit<Table[Code]>, options?: ErrorOptions): CliError;
 export {};

package/dist/error-table.js

@@ -3,7 +3,11 @@ import { CliError } from "./errors.js";
 export function defineErrors(table) {
     return table;
 }
-/** A `CliError` for a code of `table`, whose `details` must match the code's schema. */
+/**
+ * A `CliError` for a code of `table`, whose `details` must match the code's schema. The `hint`
+ * names the next command to run and says whether running it again can help; `retryAt` (ISO 8601)
+ * is allowed only on a wait-class code.
+ */
 export function cliError(_table, code, init, options) {
     return new CliError({ ...init, code }, options);
 }

package/dist/error-table.js.map

@@ -1 +1 @@
-{"version":3,"file":"error-table.js","sourceRoot":"","sources":["../src/error-table.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAcvC,oGAAoG;AACpG,MAAM,UAAU,YAAY,CAAiC,KAAY;IACvE,OAAO,KAAK,CAAC;AACf,CAAC;AAmBD,wFAAwF;AACxF,MAAM,UAAU,QAAQ,CACtB,MAAa,EACb,IAAU,EACV,IAA+B,EAC/B,OAAsB;IAEtB,OAAO,IAAI,QAAQ,CAAC,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;AAClD,CAAC"}
+{"version":3,"file":"error-table.js","sourceRoot":"","sources":["../src/error-table.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAevC,oGAAoG;AACpG,MAAM,UAAU,YAAY,CAAiC,KAAY;IACvE,OAAO,KAAK,CAAC;AACf,CAAC;AAmBD;;;;GAIG;AACH,MAAM,UAAU,QAAQ,CACtB,MAAa,EACb,IAAU,EACV,IAA+B,EAC/B,OAAsB;IAEtB,OAAO,IAAI,QAAQ,CAAC,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;AAClD,CAAC"}

package/dist/errors.d.ts

@@ -1,4 +1,4 @@
-import type { Env } from "./define.js";
+import type { Env } from "./context.js";
 import type { Style } from "./style.js";
 export interface CliErrorFields {
     readonly code: string;
@@ -27,13 +27,22 @@ export interface ErrorFormat {
     readonly json: boolean;
     readonly env: Env;
     readonly style: Style;
+    /** Where the CLI takes bug reports, read from package.json `bugs` only when a hint names it. */
+    readonly bugs?: () => string | undefined;
     /** Whether `error` is a bug: not a `CliError`, or one whose code nobody declared. */
     readonly isBug: (error: unknown) => boolean;
 }
 export declare function errnoOf(error: unknown): string | undefined;
 export declare function isMissingFile(error: unknown): boolean;
+export declare function isNothingThere(error: unknown): boolean;
 export declare function debugVariable(cliName: string): string;
 export declare function messageOf(error: unknown): string;
-/** The errors a run failed with: each one an `AggregateError` holds, or the one it threw. */
+export declare function isDebug({ env, cliName }: Pick<ErrorFormat, "env" | "cliName">): boolean;
+export declare function causesOf(error: unknown): unknown[];
+export declare function traceOf(error: unknown): string;
+/**
+ * The errors a run failed with: the leaves of nested `AggregateError`s, or the one it threw. An
+ * empty `AggregateError` is a leaf.
+ */
 export declare function errorsOf(error: unknown): readonly unknown[];
 export declare function formatRuntimeError(error: unknown, format: ErrorFormat): string;

package/dist/errors.js

@@ -28,19 +28,27 @@ export function errnoOf(error) {
 export function isMissingFile(error) {
     return errnoOf(error) === "ENOENT";
 }
+// ENOTDIR: a part of the path is a file, so nothing can exist under it.
+export function isNothingThere(error) {
+    return isMissingFile(error) || errnoOf(error) === "ENOTDIR";
+}
 export function debugVariable(cliName) {
     return `${cliName.toUpperCase().replace(/[^A-Z0-9]/g, "_")}_DEBUG`;
 }
 export function messageOf(error) {
     return error instanceof Error ? error.message : String(error);
 }
-function isDebug({ env, cliName }) {
+export function isDebug({ env, cliName }) {
     return Boolean(env[debugVariable(cliName)]);
 }
 function bugHint(format) {
-    return isDebug(format)
-        ? "the stack trace shows where it failed"
-        : `rerun with ${debugVariable(format.cliName)}=1 to see the stack trace`;
+    const bugs = format.bugs?.();
+    if (isDebug(format)) {
+        const where = "the stack trace shows where it failed";
+        return bugs === undefined ? where : `${where}; report it at ${bugs}`;
+    }
+    const rerun = `rerun with ${debugVariable(format.cliName)}=1 to see the stack trace`;
+    return bugs === undefined ? rerun : `${rerun}, then report it at ${bugs}`;
 }
 function fieldsOf(error, format) {
     if (error instanceof CliError) {
@@ -49,12 +57,12 @@ function fieldsOf(error, format) {
     }
     return { code: INTERNAL_CODE, message: messageOf(error), hint: bugHint(format) };
 }
-function causesOf(error) {
+export function causesOf(error) {
     return error instanceof Error && error.cause !== undefined
         ? [error.cause, ...causesOf(error.cause)]
         : [];
 }
-function traceOf(error) {
+export function traceOf(error) {
     return error instanceof Error ? (error.stack ?? error.message) : String(error);
 }
 /** Under debug: a bug's stack trace, then every error's cause chain. */
@@ -67,9 +75,14 @@ function debugTrace(error, format) {
     ];
     return lines.length === 0 ? undefined : lines.join("\n");
 }
-/** The errors a run failed with: each one an `AggregateError` holds, or the one it threw. */
+/**
+ * The errors a run failed with: the leaves of nested `AggregateError`s, or the one it threw. An
+ * empty `AggregateError` is a leaf.
+ */
 export function errorsOf(error) {
-    return error instanceof AggregateError && error.errors.length > 0 ? error.errors : [error];
+    return error instanceof AggregateError && error.errors.length > 0
+        ? error.errors.flatMap(errorsOf)
+        : [error];
 }
 function errorLines(error, format) {
     const fields = fieldsOf(error, format);

package/dist/errors.js.map

@@ -1 +1 @@
-{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAaA,MAAM,OAAO,QAAS,SAAQ,KAAK;IACxB,IAAI,CAAS;IACb,IAAI,CAAS;IACb,OAAO,CAAU;IACjB,OAAO,CAAqB;IAErC,YAAY,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAkB,EAAE,OAAsB;QAC3F,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;CACF;AAID,0EAA0E;AAC1E,MAAM,OAAO,UAAW,SAAQ,QAAQ;IACtC,YAAY,MAAwB;QAClC,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC;IAC3B,CAAC;CACF;AAED,MAAM,CAAC,MAAM,aAAa,GAAG,UAAU,CAAC;AAWxC,MAAM,UAAU,OAAO,CAAC,KAAc;IACpC,OAAO,KAAK,YAAY,KAAK,IAAI,MAAM,IAAI,KAAK,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ;QAChF,CAAC,CAAC,KAAK,CAAC,IAAI;QACZ,CAAC,CAAC,SAAS,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,KAAc;IAC1C,OAAO,OAAO,CAAC,KAAK,CAAC,KAAK,QAAQ,CAAC;AACrC,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,OAAe;IAC3C,OAAO,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,YAAY,EAAE,GAAG,CAAC,QAAQ,CAAC;AACrE,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,KAAc;IACtC,OAAO,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAChE,CAAC;AAED,SAAS,OAAO,CAAC,EAAE,GAAG,EAAE,OAAO,EAAe;IAC5C,OAAO,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAC9C,CAAC;AAED,SAAS,OAAO,CAAC,MAAmB;IAClC,OAAO,OAAO,CAAC,MAAM,CAAC;QACpB,CAAC,CAAC,uCAAuC;QACzC,CAAC,CAAC,cAAc,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,2BAA2B,CAAC;AAC7E,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc,EAAE,MAAmB;IACnD,IAAI,KAAK,YAAY,QAAQ,EAAE,CAAC;QAC9B,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;QACxD,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;IACjG,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,SAAS,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;AACnF,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS;QACxD,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACzC,CAAC,CAAC,EAAE,CAAC;AACT,CAAC;AAED,SAAS,OAAO,CAAC,KAAc;IAC7B,OAAO,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AACjF,CAAC;AAED,wEAAwE;AACxE,SAAS,UAAU,CAAC,KAAc,EAAE,MAAmB;IACrD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;QAAE,OAAO,SAAS,CAAC;IACvC,MAAM,KAAK,GAAG;QACZ,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAChD,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,cAAc,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;KAClE,CAAC;IACF,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC3D,CAAC;AAED,6FAA6F;AAC7F,MAAM,UAAU,QAAQ,CAAC,KAAc;IACrC,OAAO,KAAK,YAAY,cAAc,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AAC7F,CAAC;AAED,SAAS,UAAU,CAAC,KAAc,EAAE,MAAmB;IACrD,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACvC,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACxC,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;IACzB,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;IAC5E,MAAM,KAAK,GAAG,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,CAAC;IACtD,OAAO,GAAG,KAAK,IAAI,MAAM,CAAC,OAAO,KAAK,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,IAAI,IAAI,CAAC;AACvF,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,KAAc,EAAE,MAAmB;IACpE,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC/B,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;QAChB,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACpC,GAAG,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;YACzB,KAAK,EAAE,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC;SAChC,CAAC,CAAC,CAAC;QACJ,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,IAAI,CAAC;IACpD,CAAC;IACD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACjE,CAAC"}
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAaA,MAAM,OAAO,QAAS,SAAQ,KAAK;IACxB,IAAI,CAAS;IACb,IAAI,CAAS;IACb,OAAO,CAAU;IACjB,OAAO,CAAqB;IAErC,YAAY,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAkB,EAAE,OAAsB;QAC3F,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;CACF;AAID,0EAA0E;AAC1E,MAAM,OAAO,UAAW,SAAQ,QAAQ;IACtC,YAAY,MAAwB;QAClC,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC;IAC3B,CAAC;CACF;AAED,MAAM,CAAC,MAAM,aAAa,GAAG,UAAU,CAAC;AAaxC,MAAM,UAAU,OAAO,CAAC,KAAc;IACpC,OAAO,KAAK,YAAY,KAAK,IAAI,MAAM,IAAI,KAAK,IAAI,OAAO,KAAK,CAAC,IAAI,KAAK,QAAQ;QAChF,CAAC,CAAC,KAAK,CAAC,IAAI;QACZ,CAAC,CAAC,SAAS,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,KAAc;IAC1C,OAAO,OAAO,CAAC,KAAK,CAAC,KAAK,QAAQ,CAAC;AACrC,CAAC;AAED,wEAAwE;AACxE,MAAM,UAAU,cAAc,CAAC,KAAc;IAC3C,OAAO,aAAa,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,KAAK,CAAC,KAAK,SAAS,CAAC;AAC9D,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,OAAe;IAC3C,OAAO,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,YAAY,EAAE,GAAG,CAAC,QAAQ,CAAC;AACrE,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,KAAc;IACtC,OAAO,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAChE,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,EAAE,GAAG,EAAE,OAAO,EAAwC;IAC5E,OAAO,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;AAC9C,CAAC;AAED,SAAS,OAAO,CAAC,MAAmB;IAClC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC;IAC7B,IAAI,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACpB,MAAM,KAAK,GAAG,uCAAuC,CAAC;QACtD,OAAO,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,kBAAkB,IAAI,EAAE,CAAC;IACvE,CAAC;IACD,MAAM,KAAK,GAAG,cAAc,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,2BAA2B,CAAC;IACrF,OAAO,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,uBAAuB,IAAI,EAAE,CAAC;AAC5E,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc,EAAE,MAAmB;IACnD,IAAI,KAAK,YAAY,QAAQ,EAAE,CAAC;QAC9B,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;QACxD,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;IACjG,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,SAAS,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;AACnF,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,KAAc;IACrC,OAAO,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS;QACxD,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACzC,CAAC,CAAC,EAAE,CAAC;AACT,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,KAAc;IACpC,OAAO,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AACjF,CAAC;AAED,wEAAwE;AACxE,SAAS,UAAU,CAAC,KAAc,EAAE,MAAmB;IACrD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;QAAE,OAAO,SAAS,CAAC;IACvC,MAAM,KAAK,GAAG;QACZ,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAChD,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,cAAc,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;KAClE,CAAC;IACF,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC3D,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAc;IACrC,OAAO,KAAK,YAAY,cAAc,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC;QAC/D,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC;QAChC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AACd,CAAC;AAED,SAAS,UAAU,CAAC,KAAc,EAAE,MAAmB;IACrD,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACvC,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACxC,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;IACzB,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;IAC5E,MAAM,KAAK,GAAG,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,CAAC;IACtD,OAAO,GAAG,KAAK,IAAI,MAAM,CAAC,OAAO,KAAK,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,IAAI,IAAI,CAAC;AACvF,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,KAAc,EAAE,MAAmB;IACpE,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC/B,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;QAChB,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACpC,GAAG,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;YACzB,KAAK,EAAE,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC;SAChC,CAAC,CAAC,CAAC;QACJ,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,IAAI,CAAC;IACpD,CAAC;IACD,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACjE,CAAC"}

package/dist/execute.d.ts

@@ -1,6 +1,9 @@
-import type { Command, Context } from "./define.js";
+import type { Context } from "./context.js";
+import type { Command } from "./define.js";
+import type { Files } from "./files.js";
 import type { Invocation } from "./invocation.js";
 import type { PageInput } from "./list.js";
+import { type OutputsGuard } from "./outputs.js";
 import type { Style } from "./style.js";
 export interface Outcome {
     readonly value: unknown;
@@ -19,7 +22,11 @@ export interface ExecuteFlags {
     readonly commandLine: string;
     /** Prints a serve Command's data the moment `start` returns it. */
     readonly started: (outcome: Outcome) => Promise<void>;
+    /** The file system under `ctx.files`, unresolved and unclassified, for the outputs probe. */
+    readonly files: Files;
+    /** Guards the declared outputs of `ctx.files` and the ports' files once every check passes. */
+    readonly guardOutputs: OutputsGuard["guard"];
 }
 /** Delivered data as the Command prints it, which is the data its `run` or `apply` returns. */
 export declare function deliveredOutcome(command: Command, data: unknown): Outcome;
-export declare function execute(command: Command, input: Record<string, unknown>, ctx: Context, { dryRun, confirm, yes, page, invocation, commandLine, started }: ExecuteFlags): Promise<Outcome>;
+export declare function execute(command: Command, input: Record<string, unknown>, ctx: Context, { dryRun, confirm, yes, page, invocation, commandLine, started, files, guardOutputs, }: ExecuteFlags): Promise<Outcome>;

package/dist/execute.js

@@ -1,7 +1,8 @@
 import { untilAborted } from "./abort.js";
 import { checkConfirmation } from "./confirm.js";
 import { checkCost } from "./cost.js";
-import { checkOutputs } from "./outputs.js";
+import { FORCE_FLAG } from "./flags.js";
+import { checkOutputs, probeOutputs } from "./outputs.js";
 import { checkTools } from "./tools.js";
 function outcomeOf(value, render) {
     return { value, render: (style) => render(value, style) };
@@ -32,7 +33,7 @@ function dryRunOutcome(command, plan) {
         ].join("\n"),
     };
 }
-export async function execute(command, input, ctx, { dryRun, confirm, yes, page, invocation, commandLine, started }) {
+export async function execute(command, input, ctx, { dryRun, confirm, yes, page, invocation, commandLine, started, files, guardOutputs, }) {
     await checkTools(command.tools ?? [], ctx.env);
     if (command.rows !== undefined) {
         return outcomeOf(await command.run({ ...input, ...page }, ctx), (data, style) => command.render(data, style));
@@ -49,11 +50,17 @@ export async function execute(command, input, ctx, { dryRun, confirm, yes, page,
     if (dryRun) {
         return dryRunOutcome(command, plan);
     }
-    await checkOutputs({ invocation, commandLine, force: ctx.force, files: ctx.files }, command.outputs?.(plan));
+    const outputs = command.outputs?.(plan);
+    await checkOutputs({ invocation, commandLine, force: ctx.force, files: ctx.files }, outputs);
     checkCost({ invocation, commandLine, yes }, command.cost?.(plan));
     if (command.effect === "destructive") {
         checkConfirmation({ invocation, commandLine, given: confirm }, command.confirm(plan));
     }
+    if (outputs !== undefined) {
+        await probeOutputs({ files, cwd: ctx.cwd, fileError: ctx.fileError }, outputs);
+        if (!ctx.force)
+            guardOutputs(outputs, ctx.commandLine({ add: [FORCE_FLAG.flag] }));
+    }
     return outcomeOf(await command.apply(plan, ctx), (data, style) => command.render(data, style));
 }
 //# sourceMappingURL=execute.js.map