# @faircopy/cli 中文文档

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

版本：1\.27\.3
npm 元数据更新时间：2026-11-07T06:15:22.860Z
中文译文更新时间：2026-11-14T09:01:58.017Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：125 kB，7 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：3 个
- peer 依赖：@faircopy/rules-nlp 1\.27\.3，@faircopy/rules-default 1\.27\.3
- 首次发布：2026-04-23T09:21:59.959Z
- 最新版本发布：2026-11-07T06:15:22.460Z
- 近 30 天下载量：11894（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：35（近 12 个月 35 个）

## 中文简介

公平复制的CLI——公平复制、修正、解释

## 安装

```sh
npm install @faircopy/cli
```

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

## README

# @ faircopy/ cli

这个 `faircopy` CLI 二进制.

## 安装

```sh
npm i -D faircopy
```

## 图标

```
faircopy lint [files...]     Lint the files or the configured globs
faircopy hook-stop           Claude Code Stop hook handler
faircopy --help
faircopy --version
```

## `faircopy lint` 旗帜

| 旗帜 | 默认 | 说明 |
| --- | --- | --- |
| `--config <path>` | 自动检测 | 明确配置文件 |
| `--format <name>` | `pretty` | `pretty` 编号 : `json` 编号 : `github` 编号 : `compact` 编号 : `agent-compact` |
| `--quiet` | 虚假 | 禁止警告, 只显示错误 |
| `--max-warnings <n>` | 未设定 | 如果警告超过n, 则退出 1 |
| `--no-color` | 自动 | 禁用 ANSI 颜色 |

## 退出代码

-   `0` - 干净
-   `1` 发现错误或超过警告 `--max-warnings`
-   `2` ——配置/覆盖错误:不支持选定的文件,没有匹配的文件, 或没有提取出流言

所有线性格式报告覆盖在 Stderr 上, 即使有 `--quiet`: 所选和 已检查的文件计数、 播音段和 UTF-16 字符计数, 不支持 和空文件计数,以及活动解析的规则计数。 支持的空文件 在警告中被命名。 JSON stdout仍然是诊断阵列. 明确文件 参数凌驾于与调用目录有关的配置和解析; 配置 globs 相对于已装入的配置解析 . `--config` 装入 确切的文件名。 见 [博客副本报道](https://npmcn.com/package/docs/blog-copy.md) 适配器 避免来源报告和生成内容的重复.

## 输出格式

**`pretty`** ——有色,有护理说明的诊断(TTY中的默认)

**`github`** —— 说 `::error file=...,line=...,col=...::message` gitHub 动作 PR 说明

**`json`** ——JSON系列诊断对象

**`compact`** —— 说 `path:line:col severity [ruleId] message`每行1个

**`agent-compact`** ——分组,编码代理的符号高效输出. 它包括行/列范围,消息,帮助文本,以及默认的正态跨度片段.

## 常见问题

### @faircopy/cli 是什么？

公平复制的CLI——公平复制、修正、解释

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

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

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

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

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

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

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

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

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

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

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

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