# @drzl/cli 中文文档

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

版本：4\.41\.1
npm 元数据更新时间：2026-08-29T18:35:53.154Z
中文译文更新时间：2026-11-12T23:18:05.531Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40drzl/cli
原文对照：https://npmcn.com/package/%40drzl/cli/?lang=original
源码仓库：https://github.com/use-drzl/drzl

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

- 包体积（解压后）：2.2 MB，18 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：36 个
- 首次发布：2025-09-06T11:09:55.592Z
- 最新版本发布：2026-08-29T18:35:52.768Z
- 近 30 天下载量：3163（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：61（近 12 个月 53 个）

## 中文简介

暂无中文简介

## 安装

```sh
npm install @drzl/cli
```

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

## README

# @ drzl/ cli (英语)

[![CI](https://github.com/use-drzl/drzl/actions/workflows/ci.yml/badge.svg)](https://github.com/use-drzl/drzl/actions/workflows/ci.yml) [![npm](https://img.shields.io/npm/v/%40drzl%2Fcli)](https://www.npmjs.com/package/@drzl/cli)

分析您的 Drizzle 计划并生成验证,服务和路由器.

## \* 赞助者DRZL

**DRZL是精心策划的夜晚和周末. 赞助使发电机保持快速、测试和免费.**

[![Sponsor DRZL](https://img.shields.io/badge/GitHub%20Sponsors-Support%20the%20project-ff69b4?logo=github)](https://github.com/sponsors/omar-dulaimi)

-   每美元都加速CI硬件 抵消我老旧的笔记本电脑的长测试.
-   主办方在GitHub问题上获得路线图投入和优先回应.
-   想要一个简短的概述吗? 目前的目标和感谢你们 [https://use-drzl.github.io/drzl/赞助商](https://use-drzl.github.io/drzl/sponsor)。 。 。 .

## 图标

-   输入 : `pnpm dlx @drzl/cli init`
-   分析 : `pnpm dlx @drzl/cli analyze <schema.ts> [--relations] [--validate]`
-   解释: `pnpm dlx @drzl/cli explain <table>`DRZL对一张桌子的理解 和它没有理解
-   医生: `pnpm dlx @drzl/cli doctor`,什么DRZL不能在您的计划中输入或执行,以及为什么
-   生成 : `pnpm dlx @drzl/cli generate -c drzl.config.ts`
-   监视 : `pnpm dlx @drzl/cli watch -c drzl.config.ts`

27个发电机船都是这个包的附属物 所以安装它是唯一的 安装您需要运行其中的任何一个.

## 最小配置

```ts
import { defineConfig } from '@drzl/cli/config';

export default defineConfig({
  schema: 'src/db/schemas/index.ts',
  outDir: 'src/api',
  generators: [
    { kind: 'zod', path: 'src/validators/zod' },
    { kind: 'service', path: 'src/services', dataAccess: 'drizzle' },
    { kind: 'orpc', template: '@drzl/template-orpc-service' },
  ],
});
```

页:1

-   `format.engine: 'auto'` 尝试Pretier,然后Biome。 两者都是自己的,两者都不捆绑 DRZL使用您项目中找到的, 以及您的配置 。 没有安装 生成的文件完全按照所渲染的写出, 这与无效的 TypeScript 有更糟糕的写法 白色空间。 添加 `prettier` 如果您想要格式化, 则将其作为 dev 依赖.
-   代之以命名一个引擎, `format.engine: 'prettier'` 或者说 `'biome'`,是请求而不是 ,因此无法加载的引擎会在 Stderr 上报告原因。 文件 仍然被写入, 未格式化; 没有失败 . `'auto'` 保持安静,因为它要求 无论安装了什么 没有预兆 都是合法的答案.

## 常见问题

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

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

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

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

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

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

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

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

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

@drzl/cli 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

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

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

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

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