# @coinagerie/cli 中文文档

规范地址：https://npmcn.com/package/%40coinagerie/cli/

版本：0\.0\.13
npm 元数据更新时间：2026-11-10T03:11:49.159Z
中文译文更新时间：2026-11-10T13:29:54.420Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40coinagerie/cli
原文对照：https://npmcn.com/package/%40coinagerie/cli/?lang=original
项目主页：https://github.com/organizzolini/codebase/tree/main/projects/ic-suite/coinagerie/coinagerie-cli#readme
源码仓库：https://github.com/organizzolini/codebase

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

- 包体积（解压后）：27.2 kB，8 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：12 个
- 首次发布：2026-11-04T05:30:07.561Z
- 最新版本发布：2026-11-10T03:11:48.764Z
- 近 30 天下载量：2357（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：14（近 12 个月 14 个）

## 中文简介

命令行工具,用于列出一个代码库的词汇并保持一个与代码同步的词汇表

## 安装

```sh
npm install @coinagerie/cli
```

也可以使用：`pnpm add @coinagerie/cli`、`yarn add @coinagerie/cli`、`bun add @coinagerie/cli`

## README

# @coinagerie/ cli (英语)

[![npm](https://img.shields.io/npm/v/@coinagerie/cli?logo=npm&label=npm)](https://www.npmjs.com/package/@coinagerie/cli)

**保存您代码库使用的词汇表 .**

```bash
npm install --save-dev @coinagerie/cli
```

```bash
npx @coinagerie/cli
```

## 使用量

`coinagerie` 列出一个代码库所用的单词——每个标识符,对象密钥, enum 成员、文件夹名称和文件名称, 拆分成小写字—— 并保留 与代码同步的缩放词汇表.

```bash
coinagerie                       # print the glossary block, write nothing
coinagerie --check               # exit 1 naming missing and stale words
coinagerie --write               # rewrite every glossary, keeping definitions
coinagerie --config path/to/coinagerie.config.ts --check
```

无 `--config`页:1 `coinagerie.config.ts` 在工作目录中使用 如果有,则适用默认。 文件夹 配置文件是运行扫描的根 :

```ts
export default {
  exclude: { paths: ["**/*.test.ts"] },
  include: ["src/**"],
  outputs: [
    { description: "Words this project uses.", path: "README.md", type: "markdown" },
  ],
};
```

每个 `.gitignore` 荣誉是荣耀, 和档案运行写 从来没有扫描。 无法完整解析的词汇块永远不会被写入 .

## 开始

```bash
nx run coinagerie-cli:start
```

## 测试

```bash
nx run coinagerie-cli:vitest
```

## \* 调和

这个项目源于 [巢js - 命令 - 项目](https://npmcn.com/package/configuration/conformetry-templates/nestjs-command-project) 符合模板.

## 常见问题

### @coinagerie/cli 是什么？

命令行工具,用于列出一个代码库的词汇并保持一个与代码同步的词汇表

### 如何安装 @coinagerie/cli？

在项目目录运行 npm install @coinagerie/cli，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 coinagerie，可以用 npx coinagerie 直接运行。

### @coinagerie/cli 支持 TypeScript 吗？

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

### @coinagerie/cli 支持 ESM 还是 CommonJS？

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

### @coinagerie/cli 可以商用吗？

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

### @coinagerie/cli 的下载量有多少？

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

### @coinagerie/cli 还在维护吗？

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