# @flowscripter/dynamic-cli-framework 中文文档

规范地址：https://npmcn.com/package/%40flowscripter/dynamic-cli-framework/

版本：12\.2\.6
npm 元数据更新时间：2026-11-12T05:02:28.887Z
中文译文更新时间：2026-11-15T00:44:40.027Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40flowscripter/dynamic-cli-framework
原文对照：https://npmcn.com/package/%40flowscripter/dynamic-cli-framework/?lang=original
项目主页：https://github.com/flowscripter/dynamic-cli-framework#readme
源码仓库：https://github.com/flowscripter/dynamic-cli-framework

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：2 MB，583 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：10 个
- peer 依赖：yaml ^2\.9\.1，typescript ^7\.0\.2，@decimalturn/toml-patch ^3\.3\.1
- 首次发布：2025-03-04T19:39:35.966Z
- 最新版本发布：2026-11-12T05:02:28.497Z
- 近 30 天下载量：3960（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：153（近 12 个月 134 个）

## 中文简介

开发支持动态发现和安装新指令的CLI应用程序的框架

## 安装

```sh
npm install @flowscripter/dynamic-cli-framework
```

也可以使用：`pnpm add @flowscripter/dynamic-cli-framework`、`yarn add @flowscripter/dynamic-cli-framework`、`bun add @flowscripter/dynamic-cli-framework`

## README

# 动态框架

[![version](https://img.shields.io/github/v/release/flowscripter/dynamic-cli-framework?sort=semver)](https://github.com/flowscripter/dynamic-cli-framework/releases) [![build](https://img.shields.io/github/actions/workflow/status/flowscripter/dynamic-cli-framework/release-bun-library.yml)](https://github.com/flowscripter/dynamic-cli-framework/actions/workflows/release-bun-library.yml) [![coverage](https://codecov.io/gh/flowscripter/dynamic-cli-framework/branch/main/graph/badge.svg?token=EMFT2938ZF)](https://codecov.io/gh/flowscripter/dynamic-cli-framework) [![docs](https://img.shields.io/badge/docs-API-blue)](https://flowscripter.github.io/dynamic-cli-framework/index.html) [![license: MIT](https://img.shields.io/github/license/flowscripter/dynamic-cli-framework)](https://github.com/flowscripter/dynamic-cli-framework/blob/main/LICENSE)

> 开发支持动态发现的CLI应用的框架 和安装新命令

## 关键特性

-   灵活的CLI定义:
    -   一个带有全局参数的默认全局命令,例如 . `executable [global_arguments]`
    -   多个子命令, 有基于子命令的参数, 例如 . `executable <sub_command> [sub_command_arguments]`
    -   多组成员子命令, 有成员子命令参数 譬如说. `executable <group_command> <member_sub_command> [member_sub_command_arguments]`
    -   上面的组合!
-   支持命名选项和基于位置的参数,例如:. `executable --<option_name>=<option_value> <positional_value>`
-   支持为下列项目指定多个值:
    -   通过下列方式命名选项参数:
        -   隐含索引式重复论证,例如:. `executable --<option_name>=<option_value_1> --<option_name>=<option_value_2>`
        -   或明确编入索引的参数,例如:. `executable --<option_name>[0]=<option_value_1> --<option_name>[1]=<option_value_2>`
    -   基于位置的参数("varrgs")例如. `executable <positional_1_value_1> <positional_1_value_2>`
-   支持复杂的嵌入式选项,例如. `executable --<option_name>.<property_1_name>=<property_1_value> --<option_name>.<property_1>.<property_1_a>=<property_1_a_value>`
-   支持(可选)持续配置和环境变量 指定命令参数默认值.
-   用于帮助,日志级别和版本管理的核心(但可选)命令.
-   颜色输出的核心(但可选)服务(前景和背景), 语法突出, 漂亮的打印, 表和树结构渲染, 配置管理,用户输入提示.
-   支持屏蔽和不屏蔽启动任务.
-   具有关机钩的光能信号处理(SIGINT/SIGTERM),合作 取消长期运行的命令,并三相中断部队退出.
-   管道或非交互运行时的慷慨降解:颜色, 超链接、提示、旋转器/进度栏和图像渲染 自动禁用,基于 `stdin`编号 :`stdout`编号 :`stderr` 是TTYs(英语:TTYs).
-   对动态发现和安装命令的核心(但可选)支持 服务 [动态插件框架](https://github.com/flowscripter/dynamic-plugin-framework)
-   最小的依赖.
-   Bun总部.
-   基于本地JavaScript模块.
-   以 Typescript 写成 .
-   使用 Bun 运行时间编译为二进制可执行文件 .

## 用法实例

现提供以下实例:

-   [实例- cli](https://github.com/flowscripter/example-cli) 是一个实例 CLI 基于此框架的应用程序.
-   [mpeg- sdl- 工具](https://github.com/flowscripter/mpeg-sdl-tool) 是一个真实的世界 基于此框架的 CLI 应用程序.
-   [例- cli- 插件](https://github.com/flowscripter/example-cli-plugin) 是一个 基于此框架的示例命令和服务插件.

## 进一步详情

-   [关键概念](https://npmcn.com/package/%40flowscripter/dynamic-cli-framework/README/key-concepts.md)
-   [执行细节](https://npmcn.com/package/%40flowscripter/dynamic-cli-framework/README/implementation-details.md)
-   [核心服务提供者](https://npmcn.com/package/%40flowscripter/dynamic-cli-framework/README/core-service-providers.md)
-   [核心命令](https://npmcn.com/package/%40flowscripter/dynamic-cli-framework/README/core-commands.md)
-   [插件](https://npmcn.com/package/%40flowscripter/dynamic-cli-framework/README/plugins.md)
-   [启动任务](https://npmcn.com/package/%40flowscripter/dynamic-cli-framework/README/startup-tasks.md)
-   [发展](https://npmcn.com/package/%40flowscripter/dynamic-cli-framework/README/development.md)
-   [API 文档](https://flowscripter.github.io/dynamic-cli-framework/index.html)

## 许可证

麻省理工学院

## 常见问题

### @flowscripter/dynamic-cli-framework 是什么？

开发支持动态发现和安装新指令的CLI应用程序的框架

### 如何安装 @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 和提交记录判断。