bun-workspaces 1.5.1 → 1.5.2

package/src/cli/index.d.ts

@@ -1,3 +1,1025 @@
-export * from "./createCli";
-export * from "./commands";
-export * from "./globalOptions";
+// Generated by dts-bundle-generator v9.5.1
+
+/** Does not change an object type, but remaps it for cleaner Intellisense only */
+export type Simplify<T extends object> = {
+  [K in keyof T]: T[K];
+};
+/** A normal `AsyncIterable` that is only intended for `for await` style iteration */
+export type SimpleAsyncIterable<T> = AsyncIterable<T, void, undefined>;
+declare const SCRIPT_SHELL_OPTIONS: readonly ["bun", "system"];
+export type ScriptShellOption = (typeof SCRIPT_SHELL_OPTIONS)[number];
+export type ShellOption = ScriptShellOption | "default";
+declare const PARALLEL_MAX_VALUES: readonly ["auto", "unbounded", "default"];
+export type PercentageValue = `${number}%`;
+/**
+ * The maximum number of scripts that can run in parallel.
+ *
+ * - `number`: The exact number of scripts that can run in parallel.
+ * - `"auto"`: The number of available logical CPU threads.
+ * - `"unbounded"`: No limit.
+ * - `"default"`: The default value, either "auto" or the value of the root config's "parallelMax" option.
+ * - `"${number}%"`: A percentage of the available logical CPU threads (e.g. "50%").
+ */
+export type ParallelMaxValue =
+  | number
+  | (typeof PARALLEL_MAX_VALUES)[number]
+  | PercentageValue;
+export type WorkspaceDependenciesRule = {
+  allowPatterns?: string[];
+  denyPatterns?: string[];
+};
+export type WorkspaceRules = {
+  workspaceDependencies?: WorkspaceDependenciesRule;
+};
+/** Configuration that applies to a specific package.json script */
+export type ScriptConfig = {
+  /**
+   * The order in which the script should be executed.
+   *
+   * Scripts with no `order` set will be executed in alphanumerical order
+   * of their relative path from the project root.
+   */
+  order?: number;
+};
+export type ResolvedWorkspaceConfig = {
+  aliases: string[];
+  tags: string[];
+  scripts: Record<string, ScriptConfig>;
+  rules: WorkspaceRules;
+};
+export type ResolvedRootConfig = {
+  defaults: {
+    parallelMax: number;
+    shell: ScriptShellOption;
+    /** `undefined` means the value was not set in the input config */
+    includeRootWorkspace: boolean | undefined;
+  };
+};
+export type OutputStreamName = "stdout" | "stderr";
+export type ProcessOutputChunk<
+  Chunk = unknown,
+  Metadata extends object = object,
+> = {
+  /** The metadata for the script that produced the output chunk */
+  metadata: Metadata;
+  /** The output chunk */
+  chunk: Chunk;
+};
+export type ByteChunk<Metadata extends object = object> = ProcessOutputChunk<
+  Uint8Array<ArrayBufferLike>,
+  Metadata
+>;
+export type TextChunk<Metadata extends object = object> = ProcessOutputChunk<
+  string,
+  Metadata
+>;
+export type BytesOutput<Metadata extends object = object> = SimpleAsyncIterable<
+  ByteChunk<Metadata>
+>;
+export type TextOutput<Metadata extends object = object> = SimpleAsyncIterable<
+  TextChunk<Metadata>
+>;
+export interface MultiProcessOutput<Metadata extends object = object> {
+  bytes(): BytesOutput<Metadata>;
+  text(): TextOutput<Metadata>;
+}
+/** Metadata about a nested package within a Bun monorepo */
+export type Workspace = {
+  /** The name of the workspace from its `package.json` */
+  name: string;
+  /** Whether the workspace is the root workspace */
+  isRoot: boolean;
+  /** The relative path to the workspace from the root `package.json` */
+  path: string;
+  /** The pattern from `"workspaces"` in the root `package.json`that this workspace was matched from*/
+  matchPattern: string;
+  /** The scripts available in package.json */
+  scripts: string[];
+  /** Aliases assigned via the `"alias"` field in the workspace's config */
+  aliases: string[];
+  /** Tags assigned via the `"tags"` field in the workspace's config */
+  tags: string[];
+  /** Names of workspaces that this workspace depends on */
+  dependencies: string[];
+  /** Names of workspaces that depend on this workspace */
+  dependents: string[];
+};
+declare const WORKSPACE_SCRIPT_COMMAND_METHODS: readonly ["cd", "filter"];
+export type WorkspaceScriptCommandMethod =
+  (typeof WORKSPACE_SCRIPT_COMMAND_METHODS)[number];
+/** Basic metadata to run a script, the command string and the directory to run it in */
+export interface ScriptCommand {
+  /** The command string to run */
+  command: string;
+  /** The directory to run the command in */
+  workingDirectory: string;
+}
+export type RunScriptExit<ScriptMetadata extends object = object> = {
+  exitCode: number;
+  signal: NodeJS.Signals | null;
+  success: boolean;
+  /** Whether the script was skipped due to a failed dependency */
+  skipped?: boolean;
+  startTimeISO: string;
+  endTimeISO: string;
+  durationMs: number;
+  metadata: ScriptMetadata;
+};
+export type RunScriptsSummary<ScriptMetadata extends object = object> = {
+  totalCount: number;
+  successCount: number;
+  failureCount: number;
+  allSuccess: boolean;
+  startTimeISO: string;
+  endTimeISO: string;
+  durationMs: number;
+  scriptResults: RunScriptExit<ScriptMetadata>[];
+};
+export type ScriptEventName = "start" | "skip" | "exit";
+export type RunScriptsParallelOptions = {
+  max: ParallelMaxValue;
+};
+/** Metadata about a {@link Project}'s script, including the workspaces that have it in their package.json */
+export type WorkspaceScriptMetadata = {
+  name: string;
+  workspaces: Workspace[];
+};
+/** Arguments for {@link Project.createScriptCommand} */
+export type CreateProjectScriptCommandOptions = {
+  /** The workspace to run the script in */
+  workspaceNameOrAlias: string;
+  /** The name of the script to run */
+  scriptName: string;
+  /**
+   * The method to use to run the script.
+   * Either run in the workspace directory or use bun's --filter option.
+   * Defaults to "cd".
+   */
+  method?: WorkspaceScriptCommandMethod;
+  /** The arguments to append to the command */
+  args?: string;
+};
+/** Result of {@link Project.createScriptCommand}. Includes a command string that will run a workspace's script. */
+export type CreateProjectScriptCommandResult = {
+  /** Data including a command string using the `bun`
+   * CLI that will run a workspace's script and the
+   * directory to run it in. */
+  commandDetails: ScriptCommand;
+  /** The name of the script to run */
+  scriptName: string;
+  /** The workspace that the script belongs to */
+  workspace: Workspace;
+};
+/** The config for a project and its workspaces */
+export type ProjectConfig = {
+  root: ResolvedRootConfig;
+  /** A map of workspace names to their resolved config */
+  workspaces: Record<string, ResolvedWorkspaceConfig>;
+};
+/**
+ * A project contains a collection of workspaces and is the core of `bun-workspaces`'s functionality.
+ *
+ * Typically based on a root package.json file's `"workspaces"` field and any matching nested package.json files that are found.
+ */
+export interface Project {
+  /** The name of the project. This is typically the name of the root package.json unless otherwise provided. */
+  name: string;
+  /** The root directory of the project */
+  rootDirectory: string;
+  /** The root workspace of the project */
+  rootWorkspace: Workspace;
+  /** The list of all workspaces in the project */
+  workspaces: Workspace[];
+  /** The config for the project and its workspaces */
+  config: ProjectConfig;
+  /** The means by which the project was created */
+  sourceType: "fileSystem" | "memory";
+  /** Find a workspace by its package.json name */
+  findWorkspaceByName(workspaceName: string): Workspace | null;
+  /** Find a workspace by a workspace alias */
+  findWorkspaceByAlias(alias: string): Workspace | null;
+  /** Find a workspace that matches a workspace's name or an alias if no name matches. */
+  findWorkspaceByNameOrAlias(nameOrAlias: string): Workspace | null;
+  /** Find a list of workspaces that have a given tag in their configuration */
+  listWorkspacesWithTag(tag: string): Workspace[];
+  /** Accepts a wildcard pattern for finding a list of workspaces by their name*/
+  findWorkspacesByPattern(workspacePattern: string): Workspace[];
+  /** Get an array of all workspaces that have a given script in their package.json */
+  listWorkspacesWithScript(scriptName: string): Workspace[];
+  /** Get a mapping of all scripts to the workspaces that have them in their package.json */
+  mapScriptsToWorkspaces(): Record<string, WorkspaceScriptMetadata>;
+  /** Get a mapping of all tags to the workspaces that have them in their config */
+  mapTagsToWorkspaces(): Record<string, Workspace[]>;
+  /** Create metadata that can be used to run a workspace's script */
+  createScriptCommand(
+    options: CreateProjectScriptCommandOptions,
+  ): CreateProjectScriptCommandResult;
+}
+declare abstract class ProjectBase implements Project {
+  abstract readonly name: string;
+  abstract readonly rootDirectory: string;
+  abstract readonly rootWorkspace: Workspace;
+  abstract readonly workspaces: Workspace[];
+  abstract readonly sourceType: "fileSystem" | "memory";
+  abstract readonly config: ProjectConfig;
+  constructor(_ignoreBunVersion?: boolean);
+  listWorkspacesWithScript(scriptName: string): Workspace[];
+  mapScriptsToWorkspaces(): Record<string, WorkspaceScriptMetadata>;
+  mapTagsToWorkspaces(): Record<string, Workspace[]>;
+  findWorkspaceByName(workspaceName: string): Workspace | null;
+  findWorkspaceByAlias(alias: string): Workspace | null;
+  findWorkspaceByNameOrAlias(nameOrAlias: string): Workspace | null;
+  listWorkspacesWithTag(tag: string): Workspace[];
+  findWorkspacesByPattern(...workspacePatterns: string[]): Workspace[];
+  createScriptCommand(
+    options: CreateProjectScriptCommandOptions,
+  ): CreateProjectScriptCommandResult;
+}
+/** Arguments for {@link createFileSystemProject} */
+export type CreateFileSystemProjectOptions = {
+  /** The directory containing the root package.json. Often the same root as a git repository. Relative to process.cwd(). The default is process.cwd(). */
+  rootDirectory?: string;
+  /**
+   * The name of the project.
+   *
+   * By default will use the root package.json name
+   */
+  name?: string;
+  /** Whether to include the root workspace as a normal workspace. This overrides any config or env var settings. */
+  includeRootWorkspace?: boolean;
+};
+export type InlineScriptOptions = {
+  /** A name to act as a label for the inline script */
+  scriptName?: string;
+  /** Whether to run the script as an inline command */
+  shell?: ShellOption;
+};
+/** Arguments for `FileSystemProject.runWorkspaceScript` */
+export type RunWorkspaceScriptOptions = {
+  /** The name of the workspace to run the script in */
+  workspaceNameOrAlias: string;
+  /** The name of the script to run, or an inline command when `inline` is true */
+  script: string;
+  /** Whether to run the script as an inline command */
+  inline?: boolean | InlineScriptOptions;
+  /** The arguments to append to the script command. If passed as a string, the argv will be parsed POSIX-style */
+  args?: string | string[];
+  /** Set to `true` to ignore all output from the script. This saves memory when you don't need script output. */
+  ignoreOutput?: boolean;
+};
+/** Metadata associated with a workspace script */
+export type RunWorkspaceScriptMetadata = {
+  /** The workspace that the script was run in */
+  workspace: Workspace;
+};
+export type RunWorkspaceScriptExit = Simplify<
+  RunScriptExit<RunWorkspaceScriptMetadata>
+>;
+export type RunWorkspaceScriptProcessOutput = MultiProcessOutput<
+  RunWorkspaceScriptMetadata & {
+    streamName: OutputStreamName;
+  }
+>;
+/** Result of `FileSystemProject.runWorkspaceScript` */
+export type RunWorkspaceScriptResult = {
+  /** Use to get the output of the script */
+  output: RunWorkspaceScriptProcessOutput;
+  /** The exit result of the script */
+  exit: Promise<RunWorkspaceScriptExit>;
+};
+export type ParallelOption = boolean | RunScriptsParallelOptions;
+export type ScriptEventMetadata = {
+  /** The workspace that the script event occurred in */
+  workspace: Workspace;
+  /** The exit result of the script */
+  exitResult: RunScriptExit<RunWorkspaceScriptMetadata> | null;
+};
+export type OnScriptEventCallback = (
+  /** The event that occurred */
+  event: ScriptEventName,
+  /** The metadata for the script event */
+  metadata: ScriptEventMetadata,
+) => unknown;
+/** Arguments for `FileSystemProject.runScriptAcrossWorkspaces` */
+export type RunScriptAcrossWorkspacesOptions = {
+  /**
+   * Workspace names, aliases, or patterns including a wildcard.
+   *
+   * When not provided, all workspaces that the script can be ran in will be used.
+   */
+  workspacePatterns?: string[];
+  /** The name of the script to run, or an inline command when `inline` is true */
+  script: string;
+  /** Whether to run the script as an inline command */
+  inline?: boolean | InlineScriptOptions;
+  /** The arguments to append to the script command. If passed as a string, the argv will be parsed POSIX-style */
+  args?: string | string[];
+  /** Whether to run the scripts in parallel (default: `true`). Pass `false` to run in series. */
+  parallel?: ParallelOption;
+  /** When `true`, run scripts so that dependent workspaces run only after their dependencies */
+  dependencyOrder?: boolean;
+  /** When `true`, continue running scripts even if a dependency fails (Only relevant when `dependencyOrder` is `true`) */
+  ignoreDependencyFailure?: boolean;
+  /** Set to `true` to ignore all output from the scripts. This saves memory when you don't need script output. */
+  ignoreOutput?: boolean;
+  /** Callback to invoke when a script event occurs (start, skip, exit) */
+  onScriptEvent?: OnScriptEventCallback;
+};
+export type RunScriptAcrossWorkspacesSummary = Simplify<
+  RunScriptsSummary<RunWorkspaceScriptMetadata>
+>;
+export type RunScriptAcrossWorkspacesOutput = MultiProcessOutput<
+  RunWorkspaceScriptMetadata & {
+    streamName: OutputStreamName;
+  }
+>;
+/** Result of `FileSystemProject.runScriptAcrossWorkspaces` */
+export type RunScriptAcrossWorkspacesResult = {
+  /** Use to get the output of the scripts */
+  output: RunScriptAcrossWorkspacesOutput;
+  /** The summary of the script run with exit details for each workspace */
+  summary: Promise<RunScriptAcrossWorkspacesSummary>;
+  /** The workspaces targeted */
+  workspaces: Workspace[];
+};
+declare class _FileSystemProject extends ProjectBase implements Project {
+  #private;
+  readonly rootDirectory: string;
+  readonly workspaces: Workspace[];
+  readonly name: string;
+  readonly sourceType = "fileSystem";
+  readonly config: ProjectConfig;
+  readonly rootWorkspace: Workspace;
+  constructor(options: CreateFileSystemProjectOptions);
+  runWorkspaceScript(
+    options: RunWorkspaceScriptOptions,
+  ): RunWorkspaceScriptResult;
+  runScriptAcrossWorkspaces(
+    options: RunScriptAcrossWorkspacesOptions,
+  ): RunScriptAcrossWorkspacesResult;
+}
+/** An implementation of {@link Project} that is created from a root directory in the file system. */
+export type FileSystemProject = Simplify<_FileSystemProject>;
+declare const LOG_LEVELS: readonly ["debug", "info", "warn", "error"];
+export type LogLevel = (typeof LOG_LEVELS)[number];
+export type LogLevelSetting = LogLevel | "silent";
+export interface CliCommandConfig {
+  command: string;
+  isGlobal: boolean;
+  aliases: string[] | readonly string[];
+  description: string;
+  options: Record<
+    string,
+    {
+      flags: string[] | readonly string[];
+      description: string;
+      values?: string[];
+      deprecated?: boolean;
+    }
+  >;
+}
+export type CliCommandName = keyof typeof CLI_COMMANDS_CONFIG;
+export type CliGlobalCommandName = {
+  [K in CliCommandName]: (typeof CLI_COMMANDS_CONFIG)[K] extends {
+    isGlobal: true;
+  }
+    ? K
+    : never;
+}[CliCommandName];
+export type CliProjectCommandName = Exclude<
+  CliCommandName,
+  CliGlobalCommandName
+>;
+export declare const JSON_FLAGS: readonly ["-j", "--json"];
+export declare const PRETTY_FLAGS: readonly ["-p", "--pretty"];
+export declare const CLI_COMMANDS_CONFIG: {
+  readonly doctor: {
+    readonly command: "doctor";
+    readonly isGlobal: true;
+    readonly aliases: [];
+    readonly description: "Print diagnostic information";
+    readonly options: {
+      readonly json: {
+        readonly flags: readonly ["-j", "--json"];
+        readonly description: "Output as JSON";
+      };
+      readonly pretty: {
+        readonly flags: readonly ["-p", "--pretty"];
+        readonly description: "Pretty print JSON";
+      };
+    };
+  };
+  readonly listWorkspaces: {
+    readonly command: "list-workspaces [workspacePatterns...]";
+    readonly isGlobal: false;
+    readonly aliases: ["ls", "list"];
+    readonly description: "List all workspaces";
+    readonly options: {
+      readonly workspacePatterns: {
+        readonly flags: ["-W", "--workspace-patterns <patterns>"];
+        readonly description: "Workspace patterns to match, separated by spaces";
+      };
+      readonly nameOnly: {
+        readonly flags: ["-n", "--name-only"];
+        readonly description: "Only show workspace names";
+      };
+      readonly json: {
+        readonly flags: readonly ["-j", "--json"];
+        readonly description: "Output as JSON";
+      };
+      readonly pretty: {
+        readonly flags: readonly ["-p", "--pretty"];
+        readonly description: "Pretty print JSON";
+      };
+    };
+  };
+  readonly listScripts: {
+    readonly command: "list-scripts";
+    readonly isGlobal: false;
+    readonly aliases: ["ls-scripts"];
+    readonly description: "List all scripts available with their workspaces";
+    readonly options: {
+      readonly nameOnly: {
+        readonly flags: ["-n", "--name-only"];
+        readonly description: "Only show script names";
+      };
+      readonly json: {
+        readonly flags: readonly ["-j", "--json"];
+        readonly description: "Output as JSON";
+      };
+      readonly pretty: {
+        readonly flags: readonly ["-p", "--pretty"];
+        readonly description: "Pretty print JSON";
+      };
+    };
+  };
+  readonly workspaceInfo: {
+    readonly command: "workspace-info <workspaceName>";
+    readonly isGlobal: false;
+    readonly aliases: ["info"];
+    readonly description: "Show information about a workspace";
+    readonly options: {
+      readonly json: {
+        readonly flags: readonly ["-j", "--json"];
+        readonly description: "Output as JSON";
+      };
+      readonly pretty: {
+        readonly flags: readonly ["-p", "--pretty"];
+        readonly description: "Pretty print JSON";
+      };
+    };
+  };
+  readonly scriptInfo: {
+    readonly command: "script-info <script>";
+    readonly isGlobal: false;
+    readonly aliases: [];
+    readonly description: "Show information about a script";
+    readonly options: {
+      readonly workspacesOnly: {
+        readonly flags: ["-w", "--workspaces-only"];
+        readonly description: "Only show script's workspace names";
+      };
+      readonly json: {
+        readonly flags: readonly ["-j", "--json"];
+        readonly description: "Output as JSON";
+      };
+      readonly pretty: {
+        readonly flags: readonly ["-p", "--pretty"];
+        readonly description: "Pretty print JSON";
+      };
+    };
+  };
+  readonly listTags: {
+    readonly command: "list-tags";
+    readonly isGlobal: false;
+    readonly aliases: ["ls-tags"];
+    readonly description: "List all tags available with their workspaces";
+    readonly options: {
+      readonly nameOnly: {
+        readonly flags: ["-n", "--name-only"];
+        readonly description: "Only show tag names";
+      };
+      readonly json: {
+        readonly flags: readonly ["-j", "--json"];
+        readonly description: "Output as JSON";
+      };
+      readonly pretty: {
+        readonly flags: readonly ["-p", "--pretty"];
+        readonly description: "Pretty print JSON";
+      };
+    };
+  };
+  readonly tagInfo: {
+    readonly command: "tag-info <tag>";
+    readonly isGlobal: false;
+    readonly aliases: [];
+    readonly description: "Show information about a tag";
+    readonly options: {
+      readonly json: {
+        readonly flags: readonly ["-j", "--json"];
+        readonly description: "Output as JSON";
+      };
+      readonly pretty: {
+        readonly flags: readonly ["-p", "--pretty"];
+        readonly description: "Pretty print JSON";
+      };
+    };
+  };
+  readonly mcpServer: {
+    readonly command: "mcp-server";
+    readonly isGlobal: false;
+    readonly aliases: [];
+    readonly description: "Start the bun-workspaces MCP (Model Context Protocol) server over stdio";
+    readonly options: {};
+  };
+  readonly runScript: {
+    readonly command: "run-script [script] [workspacePatterns...]";
+    readonly isGlobal: false;
+    readonly aliases: ["run"];
+    readonly description: 'Run a script in all workspaces that have it in their "scripts" field in package.json';
+    readonly options: {
+      readonly script: {
+        readonly flags: ["-S", "--script <script>"];
+        readonly description: "The script to run.";
+      };
+      readonly workspacePatterns: {
+        readonly flags: ["-W", "--workspace-patterns <patterns>"];
+        readonly description: "Workspace patterns to match, separated by spaces.";
+      };
+      readonly parallel: {
+        readonly flags: ["-P", "--parallel [max]"];
+        readonly description: 'Run the scripts in parallel. Pass "false" for series, or a concurrency limit as a number, percentage ("50%"), "auto", "default", or"unbounded"';
+      };
+      readonly args: {
+        readonly flags: ["-a", "--args <args>"];
+        readonly description: "Args to append to the script command";
+      };
+      readonly outputStyle: {
+        readonly flags: ["-o", "--output-style <style>"];
+        readonly description: "The output style to use";
+        readonly values: ["grouped", "prefixed", "plain", "none"];
+      };
+      readonly groupedLines: {
+        readonly flags: ["-L", "--grouped-lines <count>"];
+        readonly description: 'With grouped output, the max preview lines (number or "auto", default "auto")';
+      };
+      readonly noPrefix: {
+        readonly flags: ["-N", "--no-prefix"];
+        readonly description: "(DEPRECATED) Use --output-style=plain instead";
+        readonly deprecated: true;
+      };
+      readonly inline: {
+        readonly flags: ["-i", "--inline"];
+        readonly description: "Run the script as an inline command from the workspace directory";
+      };
+      readonly inlineName: {
+        readonly flags: ["-I", "--inline-name <name>"];
+        readonly description: "An optional name for the script when --inline is passed";
+      };
+      readonly shell: {
+        readonly flags: ["-s", "--shell <shell>"];
+        readonly values: ["bun", "system", "default"];
+        readonly description: "When using --inline, the shell to use to run the script";
+      };
+      readonly depOrder: {
+        readonly flags: ["-d", "--dep-order"];
+        readonly description: "Scripts for dependent workspaces run only after their dependencies";
+      };
+      readonly ignoreDepFailure: {
+        readonly flags: ["-f", "--ignore-dep-failure"];
+        readonly description: "In dependency order, continue running scripts even if a dependency fails";
+      };
+      readonly jsonOutfile: {
+        readonly flags: ["-j", "--json-outfile <file>"];
+        readonly description: "Output results in a JSON file";
+      };
+    };
+  };
+};
+export declare const getCliCommandConfig: (commandName: CliCommandName) =>
+  | {
+      readonly command: "doctor";
+      readonly isGlobal: true;
+      readonly aliases: [];
+      readonly description: "Print diagnostic information";
+      readonly options: {
+        readonly json: {
+          readonly flags: readonly ["-j", "--json"];
+          readonly description: "Output as JSON";
+        };
+        readonly pretty: {
+          readonly flags: readonly ["-p", "--pretty"];
+          readonly description: "Pretty print JSON";
+        };
+      };
+    }
+  | {
+      readonly command: "list-workspaces [workspacePatterns...]";
+      readonly isGlobal: false;
+      readonly aliases: ["ls", "list"];
+      readonly description: "List all workspaces";
+      readonly options: {
+        readonly workspacePatterns: {
+          readonly flags: ["-W", "--workspace-patterns <patterns>"];
+          readonly description: "Workspace patterns to match, separated by spaces";
+        };
+        readonly nameOnly: {
+          readonly flags: ["-n", "--name-only"];
+          readonly description: "Only show workspace names";
+        };
+        readonly json: {
+          readonly flags: readonly ["-j", "--json"];
+          readonly description: "Output as JSON";
+        };
+        readonly pretty: {
+          readonly flags: readonly ["-p", "--pretty"];
+          readonly description: "Pretty print JSON";
+        };
+      };
+    }
+  | {
+      readonly command: "list-scripts";
+      readonly isGlobal: false;
+      readonly aliases: ["ls-scripts"];
+      readonly description: "List all scripts available with their workspaces";
+      readonly options: {
+        readonly nameOnly: {
+          readonly flags: ["-n", "--name-only"];
+          readonly description: "Only show script names";
+        };
+        readonly json: {
+          readonly flags: readonly ["-j", "--json"];
+          readonly description: "Output as JSON";
+        };
+        readonly pretty: {
+          readonly flags: readonly ["-p", "--pretty"];
+          readonly description: "Pretty print JSON";
+        };
+      };
+    }
+  | {
+      readonly command: "workspace-info <workspaceName>";
+      readonly isGlobal: false;
+      readonly aliases: ["info"];
+      readonly description: "Show information about a workspace";
+      readonly options: {
+        readonly json: {
+          readonly flags: readonly ["-j", "--json"];
+          readonly description: "Output as JSON";
+        };
+        readonly pretty: {
+          readonly flags: readonly ["-p", "--pretty"];
+          readonly description: "Pretty print JSON";
+        };
+      };
+    }
+  | {
+      readonly command: "script-info <script>";
+      readonly isGlobal: false;
+      readonly aliases: [];
+      readonly description: "Show information about a script";
+      readonly options: {
+        readonly workspacesOnly: {
+          readonly flags: ["-w", "--workspaces-only"];
+          readonly description: "Only show script's workspace names";
+        };
+        readonly json: {
+          readonly flags: readonly ["-j", "--json"];
+          readonly description: "Output as JSON";
+        };
+        readonly pretty: {
+          readonly flags: readonly ["-p", "--pretty"];
+          readonly description: "Pretty print JSON";
+        };
+      };
+    }
+  | {
+      readonly command: "list-tags";
+      readonly isGlobal: false;
+      readonly aliases: ["ls-tags"];
+      readonly description: "List all tags available with their workspaces";
+      readonly options: {
+        readonly nameOnly: {
+          readonly flags: ["-n", "--name-only"];
+          readonly description: "Only show tag names";
+        };
+        readonly json: {
+          readonly flags: readonly ["-j", "--json"];
+          readonly description: "Output as JSON";
+        };
+        readonly pretty: {
+          readonly flags: readonly ["-p", "--pretty"];
+          readonly description: "Pretty print JSON";
+        };
+      };
+    }
+  | {
+      readonly command: "tag-info <tag>";
+      readonly isGlobal: false;
+      readonly aliases: [];
+      readonly description: "Show information about a tag";
+      readonly options: {
+        readonly json: {
+          readonly flags: readonly ["-j", "--json"];
+          readonly description: "Output as JSON";
+        };
+        readonly pretty: {
+          readonly flags: readonly ["-p", "--pretty"];
+          readonly description: "Pretty print JSON";
+        };
+      };
+    }
+  | {
+      readonly command: "mcp-server";
+      readonly isGlobal: false;
+      readonly aliases: [];
+      readonly description: "Start the bun-workspaces MCP (Model Context Protocol) server over stdio";
+      readonly options: {};
+    }
+  | {
+      readonly command: "run-script [script] [workspacePatterns...]";
+      readonly isGlobal: false;
+      readonly aliases: ["run"];
+      readonly description: 'Run a script in all workspaces that have it in their "scripts" field in package.json';
+      readonly options: {
+        readonly script: {
+          readonly flags: ["-S", "--script <script>"];
+          readonly description: "The script to run.";
+        };
+        readonly workspacePatterns: {
+          readonly flags: ["-W", "--workspace-patterns <patterns>"];
+          readonly description: "Workspace patterns to match, separated by spaces.";
+        };
+        readonly parallel: {
+          readonly flags: ["-P", "--parallel [max]"];
+          readonly description: 'Run the scripts in parallel. Pass "false" for series, or a concurrency limit as a number, percentage ("50%"), "auto", "default", or"unbounded"';
+        };
+        readonly args: {
+          readonly flags: ["-a", "--args <args>"];
+          readonly description: "Args to append to the script command";
+        };
+        readonly outputStyle: {
+          readonly flags: ["-o", "--output-style <style>"];
+          readonly description: "The output style to use";
+          readonly values: ["grouped", "prefixed", "plain", "none"];
+        };
+        readonly groupedLines: {
+          readonly flags: ["-L", "--grouped-lines <count>"];
+          readonly description: 'With grouped output, the max preview lines (number or "auto", default "auto")';
+        };
+        readonly noPrefix: {
+          readonly flags: ["-N", "--no-prefix"];
+          readonly description: "(DEPRECATED) Use --output-style=plain instead";
+          readonly deprecated: true;
+        };
+        readonly inline: {
+          readonly flags: ["-i", "--inline"];
+          readonly description: "Run the script as an inline command from the workspace directory";
+        };
+        readonly inlineName: {
+          readonly flags: ["-I", "--inline-name <name>"];
+          readonly description: "An optional name for the script when --inline is passed";
+        };
+        readonly shell: {
+          readonly flags: ["-s", "--shell <shell>"];
+          readonly values: ["bun", "system", "default"];
+          readonly description: "When using --inline, the shell to use to run the script";
+        };
+        readonly depOrder: {
+          readonly flags: ["-d", "--dep-order"];
+          readonly description: "Scripts for dependent workspaces run only after their dependencies";
+        };
+        readonly ignoreDepFailure: {
+          readonly flags: ["-f", "--ignore-dep-failure"];
+          readonly description: "In dependency order, continue running scripts even if a dependency fails";
+        };
+        readonly jsonOutfile: {
+          readonly flags: ["-j", "--json-outfile <file>"];
+          readonly description: "Output results in a JSON file";
+        };
+      };
+    };
+export declare const getCliCommandNames: () => CliCommandName[];
+export interface CliGlobalOptions {
+  logLevel: LogLevelSetting;
+  cwd: string;
+  includeRoot: boolean;
+  workspaceRoot: boolean;
+}
+export interface CliGlobalOptionConfig {
+  mainOption: string;
+  shortOption: string;
+  description: string;
+  defaultValue: string;
+  values: string[] | null;
+  param: string;
+}
+export type CliGlobalOptionName = keyof CliGlobalOptions;
+export declare const getCliGlobalOptionConfig: (
+  optionName: CliGlobalOptionName,
+) =>
+  | {
+      readonly mainOption: "--log-level";
+      readonly shortOption: "-l";
+      readonly description: "Log levels";
+      readonly defaultValue: "info";
+      readonly values: ("debug" | "info" | "warn" | "error" | "silent")[];
+      readonly param: "level";
+    }
+  | {
+      readonly mainOption: "--cwd";
+      readonly shortOption: "-d";
+      readonly description: "Working directory";
+      readonly defaultValue: "";
+      readonly values: null;
+      readonly param: "path";
+    }
+  | {
+      readonly mainOption: "--include-root";
+      readonly shortOption: "-r";
+      readonly description: "Include the root workspace as a normal workspace";
+      readonly defaultValue: "";
+      readonly values: null;
+      readonly param: "";
+    }
+  | {
+      readonly mainOption: "--workspace-root";
+      readonly shortOption: "-w";
+      readonly description: "Run from the project root above the current working directory";
+      readonly defaultValue: "";
+      readonly values: null;
+      readonly param: "";
+    };
+export declare const getCliGlobalOptionNames: () => CliGlobalOptionName[];
+/** @todo DRY use of output text in cases such as having no workspaces/scripts */
+export type GlobalCommandContext = {
+  program: Command;
+  postTerminatorArgs: string[];
+  middleware: CliMiddleware;
+  outputWriters: Required<WriteOutputOptions>;
+  terminalWidth: number;
+  terminalHeight: number;
+};
+export type ProjectCommandContext = GlobalCommandContext & {
+  project: FileSystemProject;
+  projectError: Error | null;
+};
+export type InitProgramContext = {
+  commanderProgram: CommanderProgram;
+  argv: string[];
+};
+export type ProcessArgvContext = {
+  commanderProgram: CommanderProgram;
+  args: string[];
+  postTerminatorArgs: string[];
+};
+export type ProcessWorkingDirectoryContext = {
+  commanderProgram: CommanderProgram;
+  workingDirectory: string;
+  exists: boolean;
+  isDirectory: boolean;
+};
+export type FindProjectContext = {
+  commanderProgram: CommanderProgram;
+  project: FileSystemProject;
+  projectError: Error | null;
+};
+export type PreParseContext = {
+  commanderProgram: CommanderProgram;
+  args: string[];
+  project: FileSystemProject;
+  projectError: Error | null;
+};
+export type PostParseContext = {
+  commanderProgram: CommanderProgram;
+  args: string[];
+  project: FileSystemProject;
+  projectError: Error | null;
+};
+export type CommandMiddlewareContext<C extends CliCommandName> = {
+  commanderProgram: CommanderProgram;
+  commandName: C;
+  commandContext: C extends CliGlobalCommandName
+    ? GlobalCommandContext
+    : ProjectCommandContext;
+  commanderActionArgs: unknown[];
+};
+export type CommandMiddleware = <C extends CliCommandName>(
+  context: CommandMiddlewareContext<C>,
+) => CommanderProgram;
+export type CliMiddleware = {
+  /** The first callback when the Commander program is created */
+  initProgram: (context: InitProgramContext) => CommanderProgram;
+  /** Before the true parsing, just splitting the argv into args and post-terminator args */
+  processArgv: (context: ProcessArgvContext) => CommanderProgram;
+  /** Before the working directory is changed */
+  processWorkingDirectory: (
+    context: ProcessWorkingDirectoryContext,
+  ) => CommanderProgram;
+  /** After the project has been initialized from global options */
+  findProject: (context: FindProjectContext) => CommanderProgram;
+  /** Before the Commander program parses the args */
+  preParse: (context: PreParseContext) => CommanderProgram;
+  /** After the Commander program has parsed the args (runs in finally block) */
+  postParse: (context: PostParseContext) => CommanderProgram;
+  /** Before a command is handled */
+  preHandleCommand: CommandMiddleware;
+  /** After a command is handled */
+  postHandleCommand: CommandMiddleware;
+  /** After the program has been parsed */
+  catchError: (error: Error) => unknown;
+};
+export type CliMiddlewareOptions = Partial<CliMiddleware>;
+export interface WriteOutputOptions {
+  stdout?: (...args: Parameters<typeof process.stdout.write>) => void;
+  stderr?: (...args: Parameters<typeof process.stderr.write>) => void;
+}
+export interface RunCliOptions {
+  argv?: string[];
+  /** Should be `true` if args do not include the binary name (e.g. `bunx bun-workspaces`) */
+  programmatic?: true;
+  middleware?: CliMiddlewareOptions;
+  writeOutput?: WriteOutputOptions;
+  terminalWidth?: number;
+  terminalHeight?: number;
+}
+export interface CLI {
+  run: (options?: RunCliOptions) => Promise<void>;
+}
+export interface CreateCliOptions {
+  defaultCwd?: string;
+  /** Always handled when the result `.run()` is called */
+  defaultMiddleware?: CliMiddlewareOptions;
+}
+export declare const createCli: ({
+  defaultCwd,
+  defaultMiddleware,
+}?: CreateCliOptions) => CLI;
+export declare const defineGlobalCommands: (
+  context: GlobalCommandContext,
+) => void;
+export declare const defineProjectCommands: (
+  context: ProjectCommandContext,
+) => void;
+export declare const mcpServer: (
+  context: ProjectCommandContext,
+) => import("commander").Command;
+export declare const runScript: (
+  context: ProjectCommandContext,
+) => import("commander").Command;
+export type RenderPlainOutputOptions = {
+  stripDisruptiveControls?: boolean;
+  prefix?: boolean;
+};
+export declare function generatePlainOutputLines(
+  output: RunScriptAcrossWorkspacesOutput,
+  { stripDisruptiveControls, prefix }: RenderPlainOutputOptions,
+): AsyncGenerator<
+  {
+    line: string;
+    metadata: RunWorkspaceScriptMetadata & {
+      streamName: OutputStreamName;
+    };
+  },
+  void,
+  unknown
+>;
+export declare const renderPlainOutput: (
+  output: RunScriptAcrossWorkspacesOutput,
+  outputWriters: Required<WriteOutputOptions>,
+  { stripDisruptiveControls, prefix }: RenderPlainOutputOptions,
+) => Promise<void>;
+export declare const initializeWithGlobalOptions: (
+  program: Command,
+  args: string[],
+  middleware: CliMiddleware,
+) => {
+  project: Simplify<{
+    readonly rootDirectory: string;
+    readonly workspaces: Workspace[];
+    readonly name: string;
+    readonly sourceType: "fileSystem";
+    readonly config: ProjectConfig;
+    readonly rootWorkspace: Workspace;
+    runWorkspaceScript(
+      options: RunWorkspaceScriptOptions,
+    ): RunWorkspaceScriptResult;
+    runScriptAcrossWorkspaces(
+      options: RunScriptAcrossWorkspacesOptions,
+    ): RunScriptAcrossWorkspacesResult;
+    listWorkspacesWithScript(scriptName: string): Workspace[];
+    mapScriptsToWorkspaces(): Record<string, WorkspaceScriptMetadata>;
+    mapTagsToWorkspaces(): Record<string, Workspace[]>;
+    findWorkspaceByName(workspaceName: string): Workspace | null;
+    findWorkspaceByAlias(alias: string): Workspace | null;
+    findWorkspaceByNameOrAlias(nameOrAlias: string): Workspace | null;
+    listWorkspacesWithTag(tag: string): Workspace[];
+    findWorkspacesByPattern(...workspacePatterns: string[]): Workspace[];
+    createScriptCommand(
+      options: CreateProjectScriptCommandOptions,
+    ): CreateProjectScriptCommandResult;
+  }>;
+  projectError: Error | null;
+};
+
+export {};