@flowscripter/dynamic-cli-framework

中文文档
12.2.6发布于 2026/11/12MITTypeScriptES Module构建来源已验证近 30 天下载 3960

A framework for developing CLI applications which supports dynamic discovery and installation of new commands

原始使用文档
文档目录4 节
  1. Key Features
  2. Usage Examples
  3. Further Details
  4. License

dynamic-cli-framework

version build coverage docs license: MIT

A framework for developing CLI applications which supports dynamic discovery and installation of new commands

Key Features

  • Flexible CLI definitions:
    • a single default global command with global arguments e.g. executable [global_arguments]
    • multiple sub-commands with sub-command based arguments e.g. executable <sub_command> [sub_command_arguments]
    • multiple grouped member sub-commands with member sub-command based arguments e.g. executable <group_command> <member_sub_command> [member_sub_command_arguments]
    • A mix of the above!
  • Support for both named option and position based arguments e.g. executable --<option_name>=<option_value> <positional_value>
  • Support for specifying multiple values for:
    • named options arguments via either:
      • implicitly indexed repeated arguments e.g. executable --<option_name>=<option_value_1> --<option_name>=<option_value_2>
      • or explicitly indexed arguments e.g. executable --<option_name>[0]=<option_value_1> --<option_name>[1]=<option_value_2>
    • position based arguments ("varargs") e.g. executable <positional_1_value_1> <positional_1_value_2>
  • Support for complex nested options e.g. executable --<option_name>.<property_1_name>=<property_1_value> --<option_name>.<property_1>.<property_1_a>=<property_1_a_value>
  • Support (optional) for persisted configuration and environment variables to specify command argument defaults.
  • Core (but optional) commands for help, logging level and version management.
  • Core (but optional) services for color output (foreground and background), syntax highlighting, pretty printing, table and tree structure rendering, configuration management, and user input prompting.
  • Support for blocking and non-blocking startup tasks.
  • Graceful signal handling (SIGINT/SIGTERM) with shutdown hooks, cooperative cancellation for long-running commands, and triple-interrupt force exit.
  • Graceful degradation when piped or run non-interactively: color, hyperlinks, prompting, spinners/progress bars and image rendering are automatically disabled based on which of stdin/stdout/stderr are TTYs.
  • Core (but optional) support for dynamic discovery and installation of commands and services using dynamic-plugin-framework
  • Minimal dependencies.
  • Bun based.
  • Based on native JavaScript modules.
  • Written in Typescript.
  • Compiled to a binary executable using a Bun runtime.

Usage Examples

The following example projects are available:

  • example-cli is an example CLI application based on this framework.
  • mpeg-sdl-tool is a real world use case CLI application based on this framework.
  • example-cli-plugin is an example command and service plugin based on this framework.

Further Details

License

MIT © Flowscripter

版本与发布记录

@flowscripter/dynamic-cli-framework 共发布 153 个版本,首次发布于 2025/03/05;过去 12 个月发布了 134 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
12.2.6latest2026/11/123 天前
12.2.52026/11/096 天前
12.2.42026/11/0510 天前
12.2.32026/11/0213 天前
12.2.22026/10/2917 天前
12.2.12026/10/2620 天前

关于 @flowscripter/dynamic-cli-framework 的常见问题

@flowscripter/dynamic-cli-framework 是什么?

A framework for developing CLI applications which supports dynamic discovery and installation of new commands

如何安装 @flowscripter/dynamic-cli-framework?

在项目目录运行 npm install @flowscripter/dynamic-cli-framework,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:typescript(^7.0.2)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@flowscripter/dynamic-cli-framework 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@flowscripter/dynamic-cli-framework 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@flowscripter/dynamic-cli-framework 可以商用吗?

@flowscripter/dynamic-cli-framework 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@flowscripter/dynamic-cli-framework 的下载量有多少?

根据 npm 官方下载统计,@flowscripter/dynamic-cli-framework 在 2026/10/15 – 2026/11/13 这 30 天内被下载 3,960 次,日均约 132 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@flowscripter/dynamic-cli-framework 还在维护吗?

最新版本 12.2.6 发布于 2026/11/12(3 天前);至今共发布 153 个版本,其中过去 12 个月发布了 134 个;首次发布于 2025/03/05。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。