# @dbx-tools/cli-args 中文文档

规范地址：https://npmcn.com/package/%40dbx-tools/cli-args/

版本：0\.9\.206
npm 元数据更新时间：2026-11-10T19:19:14.677Z
中文译文更新时间：2026-11-11T17:34:21.315Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：64.5 kB，10 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：4 个
- 首次发布：2026-10-06T06:45:17.918Z
- 最新版本发布：2026-11-10T19:19:14.301Z
- 近 30 天下载量：9194（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：97（近 12 个月 97 个）

## 中文简介

用于 dbx- tools 的 Zod 对象策略的指令参数生成

## 安装

```sh
npm install @dbx-tools/cli-args
```

也可以使用：`pnpm add @dbx-tools/cli-args`、`yarn add @dbx-tools/cli-args`、`bun add @dbx-tools/cli-args`

## README

# @dbx-tools/cli-args (英语)

从一个 Zod 生成命令旗、 帮助文本、 解析值和 argv 对象计划而不安装完整 `dbx` 软件包.

## 绑定和剖析参数

```ts
import { addArgs, parseArgs } from "@dbx-tools/cli-args";
import { Command } from "commander";
import { z } from "zod";

const OptionsSchema = z.object({
  port: z.coerce.number().default(3000).describe("Server listening port"),
  databaseUrl: z.string().url().describe("PostgreSQL connection string"),
});

const program = addArgs(new Command("demo"), OptionsSchema);
await program.parseAsync(process.argv);
const options = parseArgs(program, OptionsSchema);
```

帮助默认来自Zod和分层 `@dbx-tools/core` 配置 (环境, `.env`,捆绑,和应用程序YAML。 使用 `.meta({ env, flag, helpDefault })` 当一个字段需要确切的环境名称时,应该不列入旗帜清单,或者 应隐藏其默认值。 一个字段 `helpDefault: false` 推迟分层 配置加载直至 `parseArgs`因此渲染 `--help` 未解决 那个价值.

## 将选项序列化回 argv

```ts
import { serializeArgs } from "@dbx-tools/cli-args";

const argv = serializeArgs(OptionsSchema);
const fromValues = serializeArgs({ port: 8080, debug: false });
```

Schemas将其解析的默认值序列化. 具体对象序列化电流 数值。 布尔错变 `--no-*`,数组成为重复的旗帜,以及 收听者地址使用共享的收听地址格式.

消费指令定义了他们的计划。 这个包裹绑住指挥官,救命, 和argv序列化。 不使用命令时直接使用命令 Zod 对象计划或分层 [@ dbx 工具/ 核心](https://npmcn.com/package/node/core) 配置 .

## 常见问题

### @dbx-tools/cli-args 是什么？

用于 dbx- tools 的 Zod 对象策略的指令参数生成

### 如何安装 @dbx-tools/cli-args？

在项目目录运行 npm install @dbx-tools/cli-args，或使用 pnpm add / yarn add / bun add。

### @dbx-tools/cli-args 支持 TypeScript 吗？

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

### @dbx-tools/cli-args 支持 ESM 还是 CommonJS？

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

### @dbx-tools/cli-args 可以商用吗？

@dbx-tools/cli-args 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @dbx-tools/cli-args 的下载量有多少？

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

### @dbx-tools/cli-args 还在维护吗？

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