# @gqlkit-ts/cli 中文文档

规范地址：https://npmcn.com/package/%40gqlkit-ts/cli/

版本：0\.7\.2
npm 元数据更新时间：2026-03-17T06:17:27.318Z
中文译文更新时间：2026-11-16T21:20:50.824Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40gqlkit-ts/cli
原文对照：https://npmcn.com/package/%40gqlkit-ts/cli/?lang=original
项目主页：https://gqlkit.izumin.dev/
源码仓库：https://github.com/izumin5210/gqlkit

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

- 包体积（解压后）：1.9 MB，471 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：4 个
- peer 依赖：graphql ^16\.12\.0，typescript ^5\.9\.3
- 首次发布：2026-01-13T14:36:27.751Z
- 最新版本发布：2026-03-17T06:17:27.038Z
- 近 30 天下载量：24745（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：12（近 12 个月 12 个）

## 中文简介

只是类型和函数——写出TypeScript,生成GraphQL.

## 安装

```sh
npm install @gqlkit-ts/cli
```

也可以使用：`pnpm add @gqlkit-ts/cli`、`yarn add @gqlkit-ts/cli`、`bun add @gqlkit-ts/cli`

## README

# 克克基特语name

**只是类型和功能** ——写出TypeScript,生成GraphQL.

[![gqlkit Documents](https://img.shields.io/badge/docs-gqlkit.izumin.dev-blue?logo=nextra&labelColor=%23313244&color=%23f5c2e7)](https://gqlkit.izumin.dev/) [![License](https://img.shields.io/github/license/izumin5210/gqlkit?labelColor=%23313244&color=%23a6e3a1)](https://npmcn.com/package/%40gqlkit-ts/cli/LICENSE)

[![@gqlkit-ts/cli Version](https://img.shields.io/npm/v/%40gqlkit-ts%2Fcli?logo=npm&label=%40gqlkit-ts%2Fcli&labelColor=313244&color=CB3837)](https://www.npmjs.com/package/@gqlkit-ts/cli) [![@gqlkit-ts/runtime Version](https://img.shields.io/npm/v/%40gqlkit-ts%2Fruntime?logo=npm&label=%40gqlkit-ts%2Fruntime&labelColor=313244&color=CB3837)](https://www.npmjs.com/package/@gqlkit-ts/runtime)

## 如何运作

1.  写入类型脚本类型 `src/gqlkit/schema/` • 成为图QL类型
2.  使用 `defineQuery`, (中文(简体) ), `defineMutation`, (中文(简体) ), `defineField` 成为图QL 解析器
3.  运行 `gqlkit gen` − 产出 `typeDefs` 财务报告和审定财务报表 `resolvers` 改为 `src/gqlkit/__generated__/`

## 要点

-   **先执行** - 写类型和解析器, 生成计划当准备好。 没有编辑-再生成-执行循环.
-   **只是类型和功能** - 有薄API的普通类型脚本。 没有复杂的通则,没有装饰.
-   **类型安全** - TypeScript类型成为GraphQL类型。 在编译时检查解析器签名 .

## 开始

### 1\. 安装依赖关系

```bash
# Runtime dependencies
npm install @gqlkit-ts/runtime graphql @graphql-tools/schema

# Development dependency
npm install -D @gqlkit-ts/cli
```

### 2\. 创建类型和解决方案

```ts
// src/gqlkit/gqlkit.ts
import { createGqlkitApis } from "@gqlkit-ts/runtime";
import { Context } from "./context.js";

export const { defineField, defineQuery, defineMutation } = createGqlkitApis<Context>();
```

```ts
// src/gqlkit/schema/task.ts
import type { IDString, NoArgs } from "@gqlkit-ts/runtime";
import { defineQuery, defineMutation } from "../gqlkit.js";

export type Task = {
  id: IDString;
  title: string;
  completed: boolean;
};

const tasksData: Task[] = [];

// Query
export const tasks = defineQuery<NoArgs, Task[]>(() => tasksData);

// Mutation
export const createTask = defineMutation<{ input: { title: string } }, Task>(
  (_root, { input }) => {
    const task: Task = {
      id: crypto.randomUUID(),
      title: input.title,
      completed: false,
    };
    tasksData.push(task);
    return task;
  }
);
```

### 3\. 产生计划和解决者

```bash
gqlkit gen
```

此生成 :

-   `src/gqlkit/__generated__/typeDefs.ts` - 图QL计划AST
-   `src/gqlkit/__generated__/resolvers.ts` - 解析器地图
-   `src/gqlkit/__generated__/schema.graphql` - SDL文件

### 4\. 创建可执行计划

```ts
// src/schema.ts
import { makeExecutableSchema } from "@graphql-tools/schema";
import { typeDefs } from "./gqlkit/__generated__/typeDefs.js";
import { resolvers } from "./gqlkit/__generated__/resolvers.js";

export const schema = makeExecutableSchema({ typeDefs, resolvers });
```

### 5\. 启动 GraphQL 服务器( 如瑜伽)

```bash
npm install graphql-yoga
```

```ts
// src/server.ts
import { createServer } from "node:http";
import { createYoga } from "graphql-yoga";
import { schema } from "./schema.js";

const yoga = createYoga({ schema });
const server = createServer(yoga);

server.listen(4000, () => {
  console.log("Server running at http://localhost:4000/graphql");
});
```

运行服务器并打开 http://localhost: 4000/graphql 访问 GraphiQL :

```graphql
mutation {
  createTask(input: { title: "Learn gqlkit" }) {
    id
    title
    completed
  }
}

query {
  tasks {
    id
    title
    completed
  }
}
```

## 文档

详细用途、特征和API参考文献访问文件网站:

**[https://gqlkit.izumin.dev. 中国植物物种信息数据库](https://gqlkit.izumin.dev/)**

## 常见问题

### @gqlkit-ts/cli 是什么？

只是类型和函数——写出TypeScript,生成GraphQL\.

### 如何安装 @gqlkit-ts/cli？

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

### @gqlkit-ts/cli 支持 TypeScript 吗？

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

### @gqlkit-ts/cli 支持 ESM 还是 CommonJS？

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

### @gqlkit-ts/cli 可以商用吗？

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

### @gqlkit-ts/cli 的下载量有多少？

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

### @gqlkit-ts/cli 还在维护吗？

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

