@gqlkit-ts/cli

中文文档
0.7.2发布于 2026/03/17MITTypeScriptES Module构建来源已验证近 30 天下载 2.5万

Just types and functions — write TypeScript, generate GraphQL.

原始使用文档
文档目录9 节
  1. How it works
  2. Highlights
  3. Getting started
  4. 1. Install dependencies
  5. 2. Create types and resolvers
  6. 3. Generate schema and resolvers
  7. 4. Create the executable schema
  8. 5. Start a GraphQL server (e.g., Yoga)
  9. Documentation

gqlkit

Just types and functions — write TypeScript, generate GraphQL.

gqlkit Documents License

@gqlkit-ts/cli Version @gqlkit-ts/runtime Version

How it works

  1. Write TypeScript types in src/gqlkit/schema/ → become GraphQL types
  2. Write resolver functions using defineQuery, defineMutation, defineField → become GraphQL resolvers
  3. Run gqlkit gen → outputs typeDefs and resolvers to src/gqlkit/__generated__/

Highlights

  • Implement first - Write types and resolvers, generate schema when ready. No edit-regenerate-implement loops.
  • Just types and functions - Plain TypeScript with a thin API. No complex generics, no decorators.
  • Type-safe - TypeScript types become GraphQL types. Resolver signatures checked at compile time.

Getting started

1. Install dependencies

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

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

2. Create types and resolvers

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

export const { defineField, defineQuery, defineMutation } = createGqlkitApis<Context>();
// 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. Generate schema and resolvers

gqlkit gen

This generates:

  • src/gqlkit/__generated__/typeDefs.ts - GraphQL schema AST
  • src/gqlkit/__generated__/resolvers.ts - Resolver map
  • src/gqlkit/__generated__/schema.graphql - SDL file

4. Create the executable schema

// 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. Start a GraphQL server (e.g., Yoga)

npm install graphql-yoga
// 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");
});

Run the server and open http://localhost:4000/graphql to access GraphiQL:

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

query {
  tasks {
    id
    title
    completed
  }
}

Documentation

For detailed usage, features, and API reference, visit the documentation site:

https://gqlkit.izumin.dev

版本与发布记录

@gqlkit-ts/cli 共发布 12 个版本,首次发布于 2026/01/13;过去 12 个月发布了 12 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.7.2latest2026/03/178 个月前
0.7.12026/03/178 个月前
0.7.02026/03/168 个月前
0.6.02026/03/018 个月前
0.5.12026/02/089 个月前
0.5.02026/02/019 个月前

关于 @gqlkit-ts/cli 的常见问题

@gqlkit-ts/cli 是什么?

Just types and functions — write TypeScript, generate 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 和提交记录判断。