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

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

版本：5\.1\.8
npm 元数据更新时间：2026-11-12T04:44:44.571Z
中文译文更新时间：2026-11-15T00:44:56.425Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：251 kB，195 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- peer 依赖：typescript ^7\.0\.2
- 首次发布：2026-07-09T20:24:14.998Z
- 最新版本发布：2026-11-12T04:44:44.207Z
- 近 30 天下载量：3176（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：46（近 12 个月 46 个）

## 中文简介

API 用于 [https://github.com/flowscripter/动态-cli-框架](https://github.com/flowscripter/dynamic-cli-framework)

## 安装

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

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

## README

# 动态- cli- 框架- api

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

> API 用于 [动态框架](https://github.com/flowscripter/dynamic-cli-framework)

## 使用量

插件作者应该依赖于此软件包( 不是完整的) `@flowscripter/dynamic-cli-framework`作为 `peerDependency`数字 :

```jsonc
{
  "peerDependencies": {
    "@flowscripter/dynamic-cli-framework-api": "*",
  },
}
```

主要出口:

-   `createCLIPlugin` - 脚手架助手来建造一个 `CLIPlugin` 从a `CommandFactory` 和(或) `ServiceProviderFactory`。 。 。 .
-   `CommandFactory`, (中文(简体) ), `ServiceProviderFactory` - 插件实施的扩展接口.
-   `Command`, (中文(简体) ), `SubCommand`, (中文(简体) ), `GlobalCommand`, (中文(简体) ), `GroupCommand` - 命令类型.
-   `Context`, (中文(简体) ), `CLIConfig` - 运行时背景传递给命令.
-   核心服务接口及其 `*_SERVICE_ID` 标识符(`PrinterService`, (中文(简体) ), `TableGeneratorService`, (中文(简体) ), `SyntaxHighlighterService`, (中文(简体) ), `ConfigurationService`(例如)过去通过 `Context`。 。 。 .
-   `StartupService`编号 :`StartupTask`, (中文(简体) ), `ShutdownService`编号 :`ShutdownTask` - 优先安排的登记工作,以便在CLI启动/关闭期间运行一次,通过 `registerTask({id, priority, run})` 无论是.

见 [动态框架](https://github.com/flowscripter/dynamic-cli-framework) (d) 实施可操作的框架及其具体服务.

## API 密码

链接自动生成的 API 文件 :

[API 文档](https://flowscripter.github.io/dynamic-cli-framework-api/index.html)

# 发展

安装依赖性 :

`bun install`

构建(生产) `dist/` 对于Node.js和TypeScript消费者; Bun 直接使用原始来源:

`bun run build`

格式 :

`bunx oxfmt`

林特:

`bunx oxlint index.ts src/ tests/`

生成 HTML API 文档 :

`bunx typedoc index.ts`

## 许可证

麻省理工学院

## 常见问题

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

API 用于 https://github\.com/flowscripter/动态-cli-框架

### 如何安装 @flowscripter/dynamic-cli-framework-api？

在项目目录运行 npm install @flowscripter/dynamic-cli-framework-api，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：typescript（^7\.0\.2）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @flowscripter/dynamic-cli-framework-api 支持 TypeScript 吗？

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

### @flowscripter/dynamic-cli-framework-api 支持 ESM 还是 CommonJS？

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

### @flowscripter/dynamic-cli-framework-api 可以商用吗？

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

### @flowscripter/dynamic-cli-framework-api 的下载量有多少？

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

### @flowscripter/dynamic-cli-framework-api 还在维护吗？

最新版本 5\.1\.8 发布于 2026/11/12（3 天前）；至今共发布 46 个版本，其中过去 12 个月发布了 46 个；首次发布于 2026/07/10。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。