@flowscripter/dynamic-cli-framework 1.7.5 → 2.1.0

package/index.ts

@@ -1,5 +1,5 @@
 // Argument API
-export type { default as Argument } from "./src/api/argument/Argument.ts";
+export type { Argument } from "@flowscripter/dynamic-cli-framework-api";
 export type {
   ArgumentSingleValueType,
   ArgumentValues,
@@ -7,37 +7,37 @@ export type {
   PopulatedArgumentSingleValueType,
   PopulatedArgumentValues,
   PopulatedArgumentValueType,
-} from "./src/api/argument/ArgumentValueTypes.ts";
+} from "@flowscripter/dynamic-cli-framework-api";
 export {
   ArgumentValueTypeName,
   ComplexValueTypeName,
-} from "./src/api/argument/ArgumentValueTypes.ts";
-export type { default as ComplexOption } from "./src/api/argument/ComplexOption.ts";
-export { MAXIMUM_COMPLEX_OPTION_NESTING_DEPTH } from "./src/api/argument/ComplexOption.ts";
-export type { default as SubCommandArgument } from "./src/api/argument/SubCommandArgument.ts";
-export { MAXIMUM_ARGUMENT_ARRAY_SIZE } from "./src/api/argument/SubCommandArgument.ts";
-export type { default as GlobalCommandArgument } from "./src/api/argument/GlobalCommandArgument.ts";
-export type { default as Option } from "./src/api/argument/Option.ts";
-export type { default as Positional } from "./src/api/argument/Positional.ts";
+} from "@flowscripter/dynamic-cli-framework-api";
+export type { ComplexOption } from "@flowscripter/dynamic-cli-framework-api";
+export { MAXIMUM_COMPLEX_OPTION_NESTING_DEPTH } from "@flowscripter/dynamic-cli-framework-api";
+export type { SubCommandArgument } from "@flowscripter/dynamic-cli-framework-api";
+export { MAXIMUM_ARGUMENT_ARRAY_SIZE } from "@flowscripter/dynamic-cli-framework-api";
+export type { GlobalCommandArgument } from "@flowscripter/dynamic-cli-framework-api";
+export type { Option } from "@flowscripter/dynamic-cli-framework-api";
+export type { Positional } from "@flowscripter/dynamic-cli-framework-api";
 
 // Command API
-export type { default as Command } from "./src/api/command/Command.ts";
-export type { default as GlobalCommand } from "./src/api/command/GlobalCommand.ts";
-export type { default as GlobalModifierCommand } from "./src/api/command/GlobalModifierCommand.ts";
-export type { default as GroupCommand } from "./src/api/command/GroupCommand.ts";
-export type { default as SubCommand } from "./src/api/command/SubCommand.ts";
-export type { default as UsageExample } from "./src/api/command/UsageExample.ts";
+export type { Command } from "@flowscripter/dynamic-cli-framework-api";
+export type { GlobalCommand } from "@flowscripter/dynamic-cli-framework-api";
+export type { GlobalModifierCommand } from "@flowscripter/dynamic-cli-framework-api";
+export type { GroupCommand } from "@flowscripter/dynamic-cli-framework-api";
+export type { SubCommand } from "@flowscripter/dynamic-cli-framework-api";
+export type { UsageExample } from "@flowscripter/dynamic-cli-framework-api";
 
 // Service API
-export type { ServiceInfo, ServiceProvider } from "./src/api/service/ServiceProvider.ts";
+export type { ServiceInfo, ServiceProvider } from "@flowscripter/dynamic-cli-framework-api";
 
 // Registry API
-export type { default as CommandRegistry } from "./src/runtime/registry/CommandRegistry.ts";
-export type { default as ServiceProviderRegistry } from "./src/runtime/registry/ServiceProviderRegistry.ts";
+export type { CommandRegistry } from "@flowscripter/dynamic-cli-framework-api";
+export type { ServiceProviderRegistry } from "@flowscripter/dynamic-cli-framework-api";
 
 // Core Services
-export { ASCII_BANNER_GENERATOR_SERVICE_ID } from "./src/api/service/core/AsciiBannerGeneratorService.ts";
-export type { default as AsciiBannerGeneratorService } from "./src/api/service/core/AsciiBannerGeneratorService.ts";
+export { ASCII_BANNER_GENERATOR_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
+export type { AsciiBannerGeneratorService } from "@flowscripter/dynamic-cli-framework-api";
 export type {
   BannerColorEffects,
   BannerGenerateOptions,
@@ -46,7 +46,7 @@ export type {
   FixedColorEffect,
   GradientColorEffect,
   RainbowColorEffect,
-} from "./src/api/service/core/AsciiBannerGeneratorService.ts";
+} from "@flowscripter/dynamic-cli-framework-api";
 export { default as DefaultAsciiBannerGeneratorService } from "./src/service/asciiBannerGenerator/DefaultAsciiBannerGeneratorService.ts";
 export { default as AsciiBannerGeneratorServiceProvider } from "./src/service/asciiBannerGenerator/AsciiBannerGeneratorServiceProvider.ts";
 export { default as ChiselFontAsciiBannerGeneratorService } from "./src/service/chiselAsciiBannerGenerator/ChiselFontAsciiBannerGeneratorService.ts";
@@ -57,86 +57,86 @@ export type {
 
 export { default as BannerServiceProvider } from "./src/service/banner/BannerServiceProvider.ts";
 
-export { KEY_VALUE_SERVICE_ID } from "./src/api/service/core/KeyValueService.ts";
-export { SECRET_SENTINEL_PREFIX } from "./src/api/service/core/KeyValueService.ts";
-export type { default as KeyValueService } from "./src/api/service/core/KeyValueService.ts";
-export type { default as SecretService } from "./src/api/service/core/SecretService.ts";
+export { KEY_VALUE_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
+export { SECRET_SENTINEL_PREFIX } from "@flowscripter/dynamic-cli-framework-api";
+export type { KeyValueService } from "@flowscripter/dynamic-cli-framework-api";
+export type { SecretService } from "@flowscripter/dynamic-cli-framework-api";
 export { default as DefaultKeyValueService } from "./src/service/configuration/DefaultKeyValueService.ts";
 export { default as DefaultSecretService } from "./src/service/configuration/DefaultSecretService.ts";
 export type { SecretsApi } from "./src/service/configuration/DefaultSecretService.ts";
 export { default as ConfigCommand } from "./src/service/configuration/command/ConfigCommand.ts";
 export { default as ConfigurationServiceProvider } from "./src/service/configuration/ConfigurationServiceProvider.ts";
 
-export { PRINTER_SERVICE_ID } from "./src/api/service/core/PrinterService.ts";
-export type { default as PrinterService } from "./src/api/service/core/PrinterService.ts";
-export { Icon, Level, ProgressStyle, SpinnerStyle } from "./src/api/service/core/PrinterService.ts";
+export { PRINTER_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
+export type { PrinterService } from "@flowscripter/dynamic-cli-framework-api";
+export { Icon, Level, ProgressStyle, SpinnerStyle } from "@flowscripter/dynamic-cli-framework-api";
 export { default as DefaultPrinterService } from "./src/service/printer/DefaultPrinterService.ts";
 export { default as PrinterServiceProvider } from "./src/service/printer/PrinterServiceProvider.ts";
 
-export { SHUTDOWN_SERVICE_ID } from "./src/api/service/core/ShutdownService.ts";
-export type { default as ShutdownService } from "./src/api/service/core/ShutdownService.ts";
+export { SHUTDOWN_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
+export type { ShutdownService } from "@flowscripter/dynamic-cli-framework-api";
 export { default as DefaultShutdownService } from "./src/service/shutdown/DefaultShutdownService.ts";
 export { default as ShutdownServiceProvider } from "./src/service/shutdown/ShutdownServiceProvider.ts";
 
-export { SYNTAX_HIGHLIGHTER_SERVICE_ID } from "./src/api/service/core/SyntaxHighlighterService.ts";
-export type { default as SyntaxHighlighterService } from "./src/api/service/core/SyntaxHighlighterService.ts";
-export type { ColorScheme } from "./src/api/service/core/SyntaxHighlighterService.ts";
+export { SYNTAX_HIGHLIGHTER_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
+export type { SyntaxHighlighterService } from "@flowscripter/dynamic-cli-framework-api";
+export type { ColorScheme } from "@flowscripter/dynamic-cli-framework-api";
 export { default as DefaultSyntaxHighlighterService } from "./src/service/syntaxHighlighter/DefaultSyntaxHighlighterService.ts";
 export { default as SyntaxHighlighterServiceProvider } from "./src/service/syntaxHighlighter/SyntaxHighlighterServiceProvider.ts";
 
-export { PRETTY_PRINTER_SERVICE_ID } from "./src/api/service/core/PrettyPrinterService.ts";
-export type { default as PrettyPrinterService } from "./src/api/service/core/PrettyPrinterService.ts";
+export { PRETTY_PRINTER_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
+export type { PrettyPrinterService } from "@flowscripter/dynamic-cli-framework-api";
 export { default as DefaultPrettyPrinterService } from "./src/service/prettyPrinter/DefaultPrettyPrinterService.ts";
 export { default as PrettyPrinterServiceProvider } from "./src/service/prettyPrinter/PrettyPrinterServiceProvider.ts";
 
-export { IMAGE_PRINTER_SERVICE_ID } from "./src/api/service/core/ImagePrinterService.ts";
-export type { default as ImagePrinterService } from "./src/api/service/core/ImagePrinterService.ts";
+export { IMAGE_PRINTER_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
+export type { ImagePrinterService } from "@flowscripter/dynamic-cli-framework-api";
 export { default as DefaultImagePrinterService } from "./src/service/imagePrinter/DefaultImagePrinterService.ts";
 export { default as ImagePrinterServiceProvider } from "./src/service/imagePrinter/ImagePrinterServiceProvider.ts";
 
-export { TREE_PRINTER_SERVICE_ID } from "./src/api/service/core/TreePrinterService.ts";
-export type { default as TreePrinterService } from "./src/api/service/core/TreePrinterService.ts";
-export type { TreeNode } from "./src/api/service/core/TreePrinterService.ts";
+export { TREE_PRINTER_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
+export type { TreePrinterService } from "@flowscripter/dynamic-cli-framework-api";
+export type { TreeNode } from "@flowscripter/dynamic-cli-framework-api";
 export { default as DefaultTreePrinterService } from "./src/service/treePrinter/DefaultTreePrinterService.ts";
 export { default as TreePrinterServiceProvider } from "./src/service/treePrinter/TreePrinterServiceProvider.ts";
 
-export { TABLE_GENERATOR_SERVICE_ID } from "./src/api/service/core/TableGeneratorService.ts";
-export type { default as TableGeneratorService } from "./src/api/service/core/TableGeneratorService.ts";
+export { TABLE_GENERATOR_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
+export type { TableGeneratorService } from "@flowscripter/dynamic-cli-framework-api";
 export {
   Align,
   type CellOptions,
   type ColumnOptions,
   type RowOptions,
   type TableOptions,
-} from "./src/api/service/core/TableGeneratorService.ts";
-export { default as Table } from "./src/api/service/core/Table.ts";
+} from "@flowscripter/dynamic-cli-framework-api";
+export { Table } from "@flowscripter/dynamic-cli-framework-api";
 export { default as DefaultTableGeneratorService } from "./src/service/tableGenerator/DefaultTableGeneratorService.ts";
 export { default as TableGeneratorServiceProvider } from "./src/service/tableGenerator/TableGeneratorServiceProvider.ts";
 
-export { DATA_DUMP_GENERATOR_SERVICE_ID } from "./src/api/service/core/DataDumpGeneratorService.ts";
-export type { default as DataDumpGeneratorService } from "./src/api/service/core/DataDumpGeneratorService.ts";
+export { DATA_DUMP_GENERATOR_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
+export type { DataDumpGeneratorService } from "@flowscripter/dynamic-cli-framework-api";
 export {
   type ByteRangeColor,
   DumpFormat,
   type HexDumpGenerateOptions,
-} from "./src/api/service/core/DataDumpGeneratorService.ts";
+} from "@flowscripter/dynamic-cli-framework-api";
 export { default as DefaultDataDumpGeneratorService } from "./src/service/dataDumpGenerator/DefaultDataDumpGeneratorService.ts";
 export { default as DataDumpGeneratorServiceProvider } from "./src/service/dataDumpGenerator/DataDumpGeneratorServiceProvider.ts";
 
-export { COMPLETION_SERVICE_ID } from "./src/api/service/core/CompletionService.ts";
-export type { default as CompletionService } from "./src/api/service/core/CompletionService.ts";
-export { type CompletionItem, ShellType } from "./src/api/service/core/CompletionService.ts";
+export { COMPLETION_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
+export type { CompletionService } from "@flowscripter/dynamic-cli-framework-api";
+export { type CompletionItem, ShellType } from "@flowscripter/dynamic-cli-framework-api";
 export { default as DefaultCompletionService } from "./src/service/completion/DefaultCompletionService.ts";
 export { default as CompletionServiceProvider } from "./src/service/completion/CompletionServiceProvider.ts";
 
-export { PROMPTER_SERVICE_ID } from "./src/api/service/core/PrompterService.ts";
-export type { default as PrompterService } from "./src/api/service/core/PrompterService.ts";
+export { PROMPTER_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
+export type { PrompterService } from "@flowscripter/dynamic-cli-framework-api";
 export {
   type Prompt,
   type PromptOption,
   type PromptResult,
   PromptType,
-} from "./src/api/service/core/PrompterService.ts";
+} from "@flowscripter/dynamic-cli-framework-api";
 export { default as DefaultPrompterService } from "./src/service/prompter/DefaultPrompterService.ts";
 export {
   DEFAULT_PROMPTER_CONFIG,
@@ -144,19 +144,20 @@ export {
 } from "./src/service/prompter/DefaultPrompterService.ts";
 export { default as PrompterServiceProvider } from "./src/service/prompter/PrompterServiceProvider.ts";
 
-export { ARGUMENT_PROMPTER_SERVICE_ID } from "./src/api/service/core/ArgumentPrompterService.ts";
-export type { default as ArgumentPrompterService } from "./src/api/service/core/ArgumentPrompterService.ts";
-export type { ParseResult } from "./src/runtime/parser.ts";
+export { ARGUMENT_PROMPTER_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
+export type { ArgumentPrompterService } from "@flowscripter/dynamic-cli-framework-api";
+export type { ParseResult } from "@flowscripter/dynamic-cli-framework-api";
 export { default as DefaultArgumentPrompterService } from "./src/service/argumentPrompter/DefaultArgumentPrompterService.ts";
 export { default as ArgumentPrompterServiceProvider } from "./src/service/argumentPrompter/ArgumentPrompterServiceProvider.ts";
 
 // CLI API
-export type { InvalidArgument } from "./src/api/RunResult.ts";
-export type { default as Context } from "./src/api/Context.ts";
-export type { default as RunResult, InvalidArgumentReason, RunState } from "./src/api/RunResult.ts";
-export type { default as BaseCLIFeatureOptions } from "./src/api/BaseCLIFeatureOptions.ts";
-export type { default as CLIConfig } from "./src/api/CLIConfig.ts";
-export type { default as CLI } from "./src/api/CLI.ts";
+export type { InvalidArgument } from "@flowscripter/dynamic-cli-framework-api";
+export type { Context } from "@flowscripter/dynamic-cli-framework-api";
+export type { RunResult } from "@flowscripter/dynamic-cli-framework-api";
+export { InvalidArgumentReason, RunState } from "@flowscripter/dynamic-cli-framework-api";
+export type { default as BaseCLIFeatureOptions } from "./src/cli/BaseCLIFeatureOptions.ts";
+export type { CLIConfig } from "@flowscripter/dynamic-cli-framework-api";
+export type { CLI } from "@flowscripter/dynamic-cli-framework-api";
 
 // Help Commands
 export {
@@ -169,12 +170,12 @@ export {
 } from "./src/command/MultiCommandCliHelpCommand.ts";
 
 // Plugin API
-export type { default as CommandFactory } from "./src/api/plugin/CommandFactory.ts";
-export { DYNAMIC_CLI_FRAMEWORK_COMMAND_FACTORY_EXTENSION_POINT } from "./src/api/plugin/CommandFactory.ts";
-export type { default as ServiceProviderFactory } from "./src/api/plugin/ServiceProviderFactory.ts";
-export { DYNAMIC_CLI_FRAMEWORK_SERVICE_PROVIDER_FACTORY_EXTENSION_POINT } from "./src/api/plugin/ServiceProviderFactory.ts";
-export { PLUGIN_SERVICE_ID } from "./src/api/service/core/PluginService.ts";
-export type { default as PluginService } from "./src/api/service/core/PluginService.ts";
+export type { CommandFactory } from "@flowscripter/dynamic-cli-framework-api";
+export { DYNAMIC_CLI_FRAMEWORK_COMMAND_FACTORY_EXTENSION_POINT } from "@flowscripter/dynamic-cli-framework-api";
+export type { ServiceProviderFactory } from "@flowscripter/dynamic-cli-framework-api";
+export { DYNAMIC_CLI_FRAMEWORK_SERVICE_PROVIDER_FACTORY_EXTENSION_POINT } from "@flowscripter/dynamic-cli-framework-api";
+export { PLUGIN_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
+export type { PluginService } from "@flowscripter/dynamic-cli-framework-api";
 export { default as DefaultPluginServiceProvider } from "./src/service/plugin/DefaultPluginServiceProvider.ts";
 
 // Core CLI

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flowscripter/dynamic-cli-framework",
-  "version": "1.7.5",
+  "version": "2.1.0",
   "description": "A framework for developing CLI applications which supports dynamic discovery and installation of new commands",
   "keywords": [
     "bun",
@@ -48,6 +48,7 @@
     "build": "tsc -p tsconfig.build.json"
   },
   "dependencies": {
+    "@flowscripter/dynamic-cli-framework-api": "^1.0.1",
     "@flowscripter/dynamic-plugin-framework": "1.10.1",
     "emphasize": "^7.0.0",
     "fastest-levenshtein": "^1.0.16",

package/src/cli/BaseCLI.ts

@@ -1,15 +1,15 @@
-import type CLI from "../api/CLI.ts";
-import type RunResult from "../api/RunResult.ts";
-import { RunState } from "../api/RunResult.ts";
+import type { CLI } from "@flowscripter/dynamic-cli-framework-api";
+import type { RunResult } from "@flowscripter/dynamic-cli-framework-api";
+import { RunState } from "@flowscripter/dynamic-cli-framework-api";
 import getLogger from "../util/logger.ts";
 import DefaultCommandRegistry from "../runtime/registry/DefaultCommandRegistry.ts";
-import type Command from "../api/command/Command.ts";
+import type { Command } from "@flowscripter/dynamic-cli-framework-api";
 import DefaultServiceProviderRegistry from "../runtime/registry/DefaultServiceProviderRegistry.ts";
 import DefaultContext from "../runtime/DefaultContext.ts";
-import type { ServiceProvider } from "../api/service/ServiceProvider.ts";
-import type CLIConfig from "../api/CLIConfig.ts";
-import type SubCommand from "../api/command/SubCommand.ts";
-import type GlobalCommand from "../api/command/GlobalCommand.ts";
+import type { ServiceProvider } from "@flowscripter/dynamic-cli-framework-api";
+import type { CLIConfig } from "@flowscripter/dynamic-cli-framework-api";
+import type { SubCommand } from "@flowscripter/dynamic-cli-framework-api";
+import type { GlobalCommand } from "@flowscripter/dynamic-cli-framework-api";
 import {
   SingleCommandCliHelpGlobalCommand,
   SingleCommandCliHelpSubCommand,
@@ -37,11 +37,11 @@ import { printRuntimeError } from "../util/runnerHelper.ts";
 
 import { WritableStream } from "node:stream/web";
 import type Terminal from "../terminal/Terminal.ts";
-import type PrinterService from "../api/service/core/PrinterService.ts";
+import type { PrinterService } from "@flowscripter/dynamic-cli-framework-api";
 import DefaultPrinterService from "../service/printer/DefaultPrinterService.ts";
 import type Styler from "../terminal/Styler.ts";
 import type KeyReader from "../terminal/KeyReader.ts";
-import type BaseCLIFeatureOptions from "../api/BaseCLIFeatureOptions.ts";
+import type BaseCLIFeatureOptions from "./BaseCLIFeatureOptions.ts";
 import DefaultPrompterService, {
   DEFAULT_PROMPTER_CONFIG,
 } from "../service/prompter/DefaultPrompterService.ts";
@@ -70,6 +70,12 @@ const logger = getLogger("BaseCLI");
  *
  * * {@link ImagePrinterServiceProvider}
  *
+ * `keyReader` is optional. If omitted, or if the stderr {@link Terminal} is not a TTY, prompting is
+ * unavailable: {@link PrompterServiceProvider} (and {@link ArgumentPrompterServiceProvider}, if
+ * enabled) are simply not registered. If `promptingEnabled` is `true` in that situation, {@link run}
+ * throws rather than failing later inside a prompt. Similarly {@link ImagePrinterServiceProvider} is
+ * only registered if the stdout {@link Terminal} is a TTY.
+ *
  * By default the following commands are added:
  *
  * * {@link SingleCommandCliHelpSubCommand} or {@link MultiCommandCliHelpSubCommand}
@@ -80,7 +86,7 @@ const logger = getLogger("BaseCLI");
 export default class BaseCLI implements CLI {
   readonly #cliConfig: CLIConfig;
   readonly #options: Required<BaseCLIFeatureOptions>;
-  readonly #keyReader: KeyReader;
+  readonly #keyReader: KeyReader | undefined;
   readonly #stderrTerminal: Terminal;
   readonly #addedNonModifierCommands: Array<Command>;
   readonly #serviceProviderRegistry: DefaultServiceProviderRegistry;
@@ -98,7 +104,7 @@ export default class BaseCLI implements CLI {
     stdoutTerminal: Terminal,
     stderrTerminal: Terminal,
     styler: Styler,
-    keyReader: KeyReader,
+    keyReader: KeyReader | undefined,
     options?: BaseCLIFeatureOptions,
   ) {
     if (cliConfig.name.length === 0) {
@@ -210,22 +216,50 @@ export default class BaseCLI implements CLI {
     this.addServiceProvider(new PrinterServiceProvider(80, this.#printerService));
     this.addServiceProvider(new TableGeneratorServiceProvider(70));
 
-    const prompterService = new DefaultPrompterService(
-      DEFAULT_PROMPTER_CONFIG,
-      this.#stderrTerminal,
-      this.#keyReader,
-      this.#printerService,
-    );
-    prompterService.promptEnabled = this.#options.promptingEnabled;
-    this.addServiceProvider(new PrompterServiceProvider(75, prompterService));
+    const canPrompt = this.#keyReader !== undefined && this.#stderrTerminal.isTty();
+
+    if (this.#options.promptingEnabled && !canPrompt) {
+      throw new Error("promptingEnabled requires a keyReader and a TTY stderr terminal");
+    }
+
+    let prompterService: DefaultPrompterService | undefined;
+    if (canPrompt) {
+      prompterService = new DefaultPrompterService(
+        DEFAULT_PROMPTER_CONFIG,
+        this.#stderrTerminal,
+        this.#keyReader!,
+        this.#printerService,
+      );
+      prompterService.promptEnabled = this.#options.promptingEnabled;
+      this.addServiceProvider(new PrompterServiceProvider(75, prompterService));
+    } else {
+      logger.debug(
+        () =>
+          `Skipping PrompterServiceProvider: keyReader present: ${
+            this.#keyReader !== undefined
+          }, stderr isTty: ${this.#stderrTerminal.isTty()}`,
+      );
+    }
 
     if (this.#options.argumentPrompterServiceEnabled) {
-      const argumentPrompterService = new DefaultArgumentPrompterService(prompterService);
-      this.addServiceProvider(new ArgumentPrompterServiceProvider(65, argumentPrompterService));
+      if (prompterService !== undefined) {
+        const argumentPrompterService = new DefaultArgumentPrompterService(prompterService);
+        this.addServiceProvider(new ArgumentPrompterServiceProvider(65, argumentPrompterService));
+      } else {
+        logger.debug(
+          "Skipping ArgumentPrompterServiceProvider: argumentPrompterServiceEnabled is true but prompting is unavailable",
+        );
+      }
     }
 
     if (this.#options.imagePrinterServiceEnabled) {
-      this.addServiceProvider(new ImagePrinterServiceProvider(55, this.#stdoutTerminal));
+      if (this.#stdoutTerminal.isTty()) {
+        this.addServiceProvider(new ImagePrinterServiceProvider(55, this.#stdoutTerminal));
+      } else {
+        logger.debug(
+          "Skipping ImagePrinterServiceProvider: imagePrinterServiceEnabled is true but stdout is not a TTY",
+        );
+      }
     }
 
     if (this.#options.completionServiceEnabled) {

package/src/cli/DefaultRuntimeCLI.ts

@@ -1,34 +1,78 @@
 import process from "node:process";
 import BaseCLI from "./BaseCLI.ts";
-import type RunResult from "../api/RunResult.ts";
-import type CLIConfig from "../api/CLIConfig.ts";
-import type BaseCLIFeatureOptions from "../api/BaseCLIFeatureOptions.ts";
+import type { RunResult } from "@flowscripter/dynamic-cli-framework-api";
+import type { CLIConfig } from "@flowscripter/dynamic-cli-framework-api";
+import type BaseCLIFeatureOptions from "./BaseCLIFeatureOptions.ts";
 import { Writable } from "node:stream";
 import TtyTerminal from "../terminal/TtyTerminal.ts";
+import NonTtyTerminal from "../terminal/NonTtyTerminal.ts";
 import TtyKeyReader from "../terminal/TtyKeyReader.ts";
 import TtyStyler from "../terminal/TtyStyler.ts";
 import supportsColor from "supports-color";
 import supportsHyperlinks from "../terminal/supportsHyperlinks.ts";
+import getLogger from "../util/logger.ts";
+
+const logger = getLogger("DefaultRuntimeCLI");
 
 /**
  * Default Bun implementation of a {@link CLI} using `process.stdout`, `process.stderr` and `process.argv`.
+ *
+ * Degrades gracefully when `stdin`, `stdout` or `stderr` are not TTYs (e.g. piped or redirected):
+ * color and hyperlinks are disabled, prompting is disabled, and non-TTY streams are wrapped in a
+ * {@link NonTtyTerminal} rather than the usual {@link TtyTerminal}.
  */
 export default class DefaultRuntimeCLI extends BaseCLI {
   constructor(cliConfig: CLIConfig, options?: BaseCLIFeatureOptions) {
+    const stdinIsTty = process.stdin.isTTY === true;
+    const stdoutIsTty = process.stdout.isTTY === true;
+    const stderrIsTty = process.stderr.isTTY === true;
+
+    logger.debug(
+      () =>
+        `stdin isTTY: ${stdinIsTty}, stdout isTTY: ${stdoutIsTty}, stderr isTTY: ${stderrIsTty}`,
+    );
+
+    const stdoutTerminal = stdoutIsTty
+      ? new TtyTerminal(process.stdout)
+      : new NonTtyTerminal(process.stdout);
+    const stderrTerminal = stderrIsTty
+      ? new TtyTerminal(process.stderr)
+      : new NonTtyTerminal(process.stderr);
+
+    logger.debug(
+      () =>
+        `stdout terminal: ${
+          stdoutIsTty ? "TtyTerminal" : "NonTtyTerminal"
+        }, stderr terminal: ${stderrIsTty ? "TtyTerminal" : "NonTtyTerminal"}`,
+    );
+
+    const colorLevel = stderrIsTty
+      ? supportsColor.stderr === false
+        ? 1
+        : supportsColor.stderr.level
+      : 0;
+
+    logger.debug(() => `color level: ${colorLevel}`);
+
+    const keyReader = stdinIsTty ? new TtyKeyReader(process.stdin) : undefined;
+
+    logger.debug(() => `keyReader constructed: ${keyReader !== undefined}`);
+
+    const promptingEnabled = stdinIsTty && stderrIsTty;
+
+    logger.debug(() => `promptingEnabled default: ${promptingEnabled}`);
+
     super(
       cliConfig,
       Writable.toWeb(process.stdout),
       Writable.toWeb(process.stderr),
       supportsColor.stdout !== false,
       supportsColor.stderr !== false,
-      new TtyTerminal(process.stdout),
-      new TtyTerminal(process.stderr),
-      new TtyStyler(
-        supportsColor.stderr === false ? 1 : supportsColor.stderr.level,
-        supportsHyperlinks(process.stderr),
-      ),
-      new TtyKeyReader(process.stdin),
-      { promptingEnabled: process.stdin.isTTY === true, ...options },
+      stdoutTerminal,
+      stderrTerminal,
+      new TtyStyler(colorLevel, supportsHyperlinks(process.stderr)),
+      keyReader,
+      { promptingEnabled, ...options },
     );
   }
 

package/src/cli/DynamicPluginRuntimeCLI.ts

@@ -1,14 +1,14 @@
 import type { MarketplacePluginManager } from "@flowscripter/dynamic-plugin-framework";
-import type CLIConfig from "../api/CLIConfig.ts";
-import type BaseCLIFeatureOptions from "../api/BaseCLIFeatureOptions.ts";
-import type RunResult from "../api/RunResult.ts";
-import { RunState } from "../api/RunResult.ts";
+import type { CLIConfig } from "@flowscripter/dynamic-cli-framework-api";
+import type BaseCLIFeatureOptions from "./BaseCLIFeatureOptions.ts";
+import type { RunResult } from "@flowscripter/dynamic-cli-framework-api";
+import { RunState } from "@flowscripter/dynamic-cli-framework-api";
 import DefaultRuntimeCLI from "./DefaultRuntimeCLI.ts";
 import DefaultPluginServiceProvider from "../service/plugin/DefaultPluginServiceProvider.ts";
-import { DYNAMIC_CLI_FRAMEWORK_COMMAND_FACTORY_EXTENSION_POINT } from "../api/plugin/CommandFactory.ts";
-import { DYNAMIC_CLI_FRAMEWORK_SERVICE_PROVIDER_FACTORY_EXTENSION_POINT } from "../api/plugin/ServiceProviderFactory.ts";
-import type CommandFactory from "../api/plugin/CommandFactory.ts";
-import type ServiceProviderFactory from "../api/plugin/ServiceProviderFactory.ts";
+import { DYNAMIC_CLI_FRAMEWORK_COMMAND_FACTORY_EXTENSION_POINT } from "@flowscripter/dynamic-cli-framework-api";
+import { DYNAMIC_CLI_FRAMEWORK_SERVICE_PROVIDER_FACTORY_EXTENSION_POINT } from "@flowscripter/dynamic-cli-framework-api";
+import type { CommandFactory } from "@flowscripter/dynamic-cli-framework-api";
+import type { ServiceProviderFactory } from "@flowscripter/dynamic-cli-framework-api";
 import process from "node:process";
 
 /**

package/src/command/MultiCommandCliHelpCommand.ts

@@ -1,14 +1,14 @@
-import type Positional from "../api/argument/Positional.ts";
-import type Option from "../api/argument/Option.ts";
-import type SubCommand from "../api/command/SubCommand.ts";
-import type GlobalCommand from "../api/command/GlobalCommand.ts";
-import type GroupCommand from "../api/command/GroupCommand.ts";
+import type { Positional } from "@flowscripter/dynamic-cli-framework-api";
+import type { Option } from "@flowscripter/dynamic-cli-framework-api";
+import type { SubCommand } from "@flowscripter/dynamic-cli-framework-api";
+import type { GlobalCommand } from "@flowscripter/dynamic-cli-framework-api";
+import type { GroupCommand } from "@flowscripter/dynamic-cli-framework-api";
 import {
   type ArgumentSingleValueType,
   type ArgumentValues,
   ArgumentValueTypeName,
-} from "../api/argument/ArgumentValueTypes.ts";
-import type Context from "../api/Context.ts";
+} from "@flowscripter/dynamic-cli-framework-api";
+import type { Context } from "@flowscripter/dynamic-cli-framework-api";
 import type { HelpSection } from "../util/helpHelper.ts";
 import {
   findPossibleCommandNames,
@@ -19,12 +19,12 @@ import {
   getSubCommandArgumentsSyntax,
   printHelpSections,
 } from "../util/helpHelper.ts";
-import type GlobalModifierCommand from "../api/command/GlobalModifierCommand.ts";
-import type CommandRegistry from "../runtime/registry/CommandRegistry.ts";
-import type PrinterService from "../api/service/core/PrinterService.ts";
-import { Icon, PRINTER_SERVICE_ID } from "../api/service/core/PrinterService.ts";
-import type TableGeneratorService from "../api/service/core/TableGeneratorService.ts";
-import { TABLE_GENERATOR_SERVICE_ID } from "../api/service/core/TableGeneratorService.ts";
+import type { GlobalModifierCommand } from "@flowscripter/dynamic-cli-framework-api";
+import type { CommandRegistry } from "@flowscripter/dynamic-cli-framework-api";
+import type { PrinterService } from "@flowscripter/dynamic-cli-framework-api";
+import { Icon, PRINTER_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
+import type { TableGeneratorService } from "@flowscripter/dynamic-cli-framework-api";
+import { TABLE_GENERATOR_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
 
 /**
  * Provides common implementation for both {@link MultiCommandCliHelpGlobalCommand} and {@link MultiCommandCliHelpSubCommand}.

package/src/command/SingleCommandCliHelpCommand.ts

@@ -1,8 +1,8 @@
-import type GlobalCommand from "../api/command/GlobalCommand.ts";
-import type SubCommand from "../api/command/SubCommand.ts";
-import type Option from "../api/argument/Option.ts";
-import type Positional from "../api/argument/Positional.ts";
-import type Context from "../api/Context.ts";
+import type { GlobalCommand } from "@flowscripter/dynamic-cli-framework-api";
+import type { SubCommand } from "@flowscripter/dynamic-cli-framework-api";
+import type { Option } from "@flowscripter/dynamic-cli-framework-api";
+import type { Positional } from "@flowscripter/dynamic-cli-framework-api";
+import type { Context } from "@flowscripter/dynamic-cli-framework-api";
 import {
   getCommandArgsHelpSections,
   getCommandExamplesHelpSections,
@@ -12,13 +12,13 @@ import {
   type HelpSection,
   printHelpSections,
 } from "../util/helpHelper.ts";
-import type GlobalModifierCommand from "../api/command/GlobalModifierCommand.ts";
-import type GroupCommand from "../api/command/GroupCommand.ts";
-import type CommandRegistry from "../runtime/registry/CommandRegistry.ts";
-import type PrinterService from "../api/service/core/PrinterService.ts";
-import { PRINTER_SERVICE_ID } from "../api/service/core/PrinterService.ts";
-import type TableGeneratorService from "../api/service/core/TableGeneratorService.ts";
-import { TABLE_GENERATOR_SERVICE_ID } from "../api/service/core/TableGeneratorService.ts";
+import type { GlobalModifierCommand } from "@flowscripter/dynamic-cli-framework-api";
+import type { GroupCommand } from "@flowscripter/dynamic-cli-framework-api";
+import type { CommandRegistry } from "@flowscripter/dynamic-cli-framework-api";
+import type { PrinterService } from "@flowscripter/dynamic-cli-framework-api";
+import { PRINTER_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
+import type { TableGeneratorService } from "@flowscripter/dynamic-cli-framework-api";
+import { TABLE_GENERATOR_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
 
 /**
  * Provides common implementation for both {@link SingleCommandCliHelpGlobalCommand} and {@link SingleCommandCliHelpSubCommand}.

package/src/command/UsageCommand.ts

@@ -1,8 +1,8 @@
-import type Context from "../api/Context.ts";
-import type GlobalCommand from "../api/command/GlobalCommand.ts";
-import type Command from "../api/command/Command.ts";
-import type PrinterService from "../api/service/core/PrinterService.ts";
-import { PRINTER_SERVICE_ID } from "../api/service/core/PrinterService.ts";
+import type { Context } from "@flowscripter/dynamic-cli-framework-api";
+import type { GlobalCommand } from "@flowscripter/dynamic-cli-framework-api";
+import type { Command } from "@flowscripter/dynamic-cli-framework-api";
+import type { PrinterService } from "@flowscripter/dynamic-cli-framework-api";
+import { PRINTER_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
 
 /**
  * Command printing basic CLI usage.

package/src/command/VersionCommand.ts

@@ -1,7 +1,7 @@
-import type Context from "../api/Context.ts";
-import type GlobalCommand from "../api/command/GlobalCommand.ts";
-import type PrinterService from "../api/service/core/PrinterService.ts";
-import { PRINTER_SERVICE_ID } from "../api/service/core/PrinterService.ts";
+import type { Context } from "@flowscripter/dynamic-cli-framework-api";
+import type { GlobalCommand } from "@flowscripter/dynamic-cli-framework-api";
+import type { PrinterService } from "@flowscripter/dynamic-cli-framework-api";
+import { PRINTER_SERVICE_ID } from "@flowscripter/dynamic-cli-framework-api";
 
 /**
  * Implementation of a {@link GlobalCommand} which outputs the version of the CLI.