# @brianmd/citty 中文文档

规范地址：https://npmcn.com/package/%40brianmd/citty/

版本：0\.0\.1
npm 元数据更新时间：2024-01-15T21:23:43.077Z
中文译文更新时间：2026-11-08T14:56:35.660Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：46.3 kB，8 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2024-01-15T21:23:42.581Z
- 最新版本发布：2024-01-15T21:23:42.828Z
- 近 30 天下载量：85831（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：1（近 12 个月 0 个）

## 中文简介

高级 CLI 构建器

## 安装

```sh
npm install @brianmd/citty
```

也可以使用：`pnpm add @brianmd/citty`、`yarn add @brianmd/citty`、`bun add @brianmd/citty`

## README

# 额 额

[![npm version](https://img.shields.io/npm/v/citty?style=flat&colorA=18181B&colorB=F0DB4F)](https://npmjs.com/package/citty) [![npm downloads](https://img.shields.io/npm/dm/citty?style=flat&colorA=18181B&colorB=F0DB4F)](https://npmjs.com/package/citty) [![bundle](https://img.shields.io/bundlephobia/minzip/citty?style=flat&colorA=18181B&colorB=F0DB4F)](https://bundlephobia.com/result?p=citty) [![Codecov](https://img.shields.io/codecov/c/gh/unjs/citty/main?style=flat&colorA=18181B&colorB=F0DB4F)](https://codecov.io/gh/unjs/citty) [![License](https://img.shields.io/github/license/unjs/citty.svg?style=flat&colorA=18181B&colorB=F0DB4F)](https://github.com/unjs/citty/blob/main/LICENSE)

> 高级 CLI 构建器

-   基于 [玛丽](https://github.com/lukeed/mri)
-   用打字机、布尔快捷键和未知旗帜处理进行智能值分析
-   嵌入子命令
-   懒惰和 Async 命令
-   可插和可堆肥的 API
-   自动生成的使用和帮助

该项目正在大力发展之中。 很快会有更多特质出现!

## 使用量

安装软件包 :

```sh
# npm
npm install citty

# yarn
yarn add citty

# pnpm
pnpm install citty
```

导入 :

```js
// ESM
import { defineCommand, runMain } from "citty";

// CommonJS
const { defineCommand, runMain } = require("citty");
```

定义要运行的主命令 :

```ts
import { defineCommand, runMain } from "citty";

const main = defineCommand({
  meta: {
    name: "hello",
    version: "1.0.0",
    description: "My Awesome CLI App",
  },
  args: {
    name: {
      type: "positional",
      description: "Your name",
      required: true,
    },
    friendly: {
      type: "boolean",
      description: "Use friendly greeting",
    },
  },
  run({ args }) {
    console.log(`${args.friendly ? "Hi" : "Greetings"} ${args.name}!`);
  },
});

runMain(main);
```

## 用户

### `defineCommand`

`defineCommand` 是一个用于定义命令的类型助手.

### `runMain`

运行一个有使用支持和优雅错误处理的命令.

### `createMain`

创建环绕命令的包装符 `runMain` 当召来.

### `runCommand`

解析输入参数并运行命令和子命令(无监督). 您可以访问 `result` 键从返回/等待的值到访问命令的结果.

### `parseArgs`

解析输入参数并应用默认值.

### `renderUsage`

将命令使用到字符串值 .

### `showUsage`

向主控台提交格式的使用和打印

## 发展

-   克隆此寄存器
-   安装 LTS 最新版本 [节点.js](https://nodejs.org/en/)
-   启用 [核心软件包](https://github.com/nodejs/corepack) 使用 `corepack enable`
-   使用 `pnpm install`
-   使用 `pnpm dev`

## 许可证

由 . . 出版 [MIT 许可证](https://npmcn.com/package/%40brianmd/citty/LICENSE)。 。 。 .

参数解析器基于 [乳头/乳头](https://github.com/lukeed/mri) 由卢克·爱德华兹(英语:[@被指责的 @](https://github.com/lukeed)) (中文(简体) ).

## 常见问题

### @brianmd/citty 是什么？

高级 CLI 构建器

### 如何安装 @brianmd/citty？

在项目目录运行 npm install @brianmd/citty，或使用 pnpm add / yarn add / bun add。

### @brianmd/citty 支持 TypeScript 吗？

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

### @brianmd/citty 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @brianmd/citty 可以商用吗？

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

### @brianmd/citty 的下载量有多少？

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

### @brianmd/citty 还在维护吗？

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