# @graphox/cli 中文文档

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

版本：1\.5\.2
npm 元数据更新时间：2026-11-16T15:14:28.698Z
中文译文更新时间：2026-11-16T22:53:24.510Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：28.1 kB，5 个文件
- TypeScript 类型：未声明
- Node.js 要求：\>=14
- 运行依赖：0 个
- 首次发布：2026-02-20T16:04:09.588Z
- 最新版本发布：2026-11-16T15:14:28.257Z
- 近 30 天下载量：40885（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：52（近 12 个月 52 个）

## 中文简介

Graphox CLI - 高性能 GraphQL 工具集

## 安装

```sh
npm install @graphox/cli
```

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

## README

# @graphox/cli (英语)

用于安装的国家预防机制软件包 `Graphox` CLI - 用于TypeScript monorepos的高性能GraphQL工具集.

## 安装

```bash
pnpm add @graphox/cli
# or
npm install @graphox/cli
# or
yarn add @graphox/cli
```

## 使用量

一旦安装完毕,您就可以使用 `Graphox` 命令 :

```bash
# Start the Language Server
pnpm graphox lsp

# Validate GraphQL files
pnpm graphox check
pnpm graphox check apps/web          # Report only files under a directory

# Generate TypeScript types
pnpm graphox codegen
pnpm graphox codegen --clean
pnpm graphox codegen --watch
pnpm graphox codegen packages/schema  # Only the projects and schema_types under a directory

# Run performance benchmarks
pnpm graphox benchmark
```

### 全球安装

```bash
pnpm add -g @graphox/cli

# Now you can use it directly
graphox lsp
graphox check
graphox codegen
```

## 支持的平台

此软件包会自动为您的平台下载正确的二进制 :

-   **马科斯**: x86 64 (英特尔)和ARM64 (苹果硅)
-   **链接**: x86 64 和 ARM64
-   **窗口**: x86 64 和 ARM64

## 特征

-   **语言服务器( LSP)**: 实时 GraphQL 验证、自动完成、去定义、盘旋文件等
-   **类型生成**: GraphQL 操作生成的脚本类型
-   **验证**: 用于GraphQL计划和操作的颗粒诊断
-   **碎片跟踪**: 包之间的自动片段依赖分辨率

## 配置

创建一个 `graphox.yaml` 中的文件。 见 [主要文件](https://github.com/soundtrackyourbrand/graphox#configuration) 详细情况.

### 编辑器支持

要在编辑器中获取验证和自动完成, 请在您的顶端添加以下一行 `graphox.yaml` 文件 :

```yaml
# yaml-language-server: $schema=node_modules/@graphox/cli/graphox.schema.json
```

或者,如果你使用 VS 代码与 [YAML 扩展名](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml),您可以在工作空间设置中添加以下内容:

```json
{
  "yaml.schemas": {
    "node_modules/@graphox/cli/graphox.schema.json": "graphox.yaml"
  }
}
```

## 手动二进制下载

如果自动安装失败, 您可以手动下载二进制 [页 次](https://github.com/soundtrackyourbrand/graphox/releases)。 。 。 .

## 仓库

[https://github.com/soundtrack你的品牌/图书](https://github.com/soundtrackyourbrand/graphox)

## 许可证

麻省理工学院——见 [自由主义](https://npmcn.com/package/%40graphox/cli/LICENSE)。 。 。 .

## 常见问题

### @graphox/cli 是什么？

Graphox CLI - 高性能 GraphQL 工具集

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

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

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

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/graphox\_\_cli 是否存在。

### @graphox/cli 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=14。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

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

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

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

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

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

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

