@drzl/cli

中文文档
4.41.1发布于 2026/08/30Apache-2.0TypeScriptES Module构建来源已验证近 30 天下载 3163
原始使用文档
文档目录3 节
  1. 💚 Sponsor DRZL
  2. Commands
  3. Minimal config

@drzl/cli

CI npm

Analyze your Drizzle schema and generate validation, services, and routers.

💚 Sponsor DRZL

DRZL is crafted nights & weekends. Sponsorships keep the generators fast, tested, and free.

Sponsor DRZL

  • Every dollar speeds up CI hardware and offsets long test runs on my aging laptop.
  • Sponsors get roadmap input and priority responses in GitHub Issues.
  • Prefer a quick overview? The current goals and thank-yous are at https://use-drzl.github.io/drzl/sponsor.

Commands

  • Init: pnpm dlx @drzl/cli init
  • Analyze: pnpm dlx @drzl/cli analyze <schema.ts> [--relations] [--validate]
  • Explain: pnpm dlx @drzl/cli explain <table>, what DRZL understood about one table and what it did not
  • Doctor: pnpm dlx @drzl/cli doctor, what DRZL cannot type or enforce in your schema, and why
  • Generate: pnpm dlx @drzl/cli generate -c drzl.config.ts
  • Watch: pnpm dlx @drzl/cli watch -c drzl.config.ts

All twenty-seven generators ship as dependencies of this package, so installing it is the only install you need to run any of them.

Minimal config

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' },
  ],
});

Notes

  • format.engine: 'auto' tries Prettier, then Biome. Both are your own: neither is bundled, and DRZL uses whichever it finds in your project, with your config. With neither installed the generated files are written exactly as rendered, which is the same valid TypeScript with worse whitespace. Add prettier as a dev dependency if you want it formatted.
  • Naming an engine instead, format.engine: 'prettier' or 'biome', is a request rather than a preference, so an engine that cannot be loaded is reported on stderr with the reason. The files are still written, unformatted; nothing fails. 'auto' stays silent, because it asked for whatever happened to be installed and no formatter is a legitimate answer to that.

版本与发布记录

@drzl/cli 共发布 61 个版本,首次发布于 2025/09/06;过去 12 个月发布了 53 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
4.41.1latest2026/08/302 个月前
4.41.02026/08/142 个月前
4.40.02026/08/142 个月前
4.39.02026/08/142 个月前
4.38.02026/08/142 个月前
4.37.02026/08/142 个月前

关于 @drzl/cli 的常见问题

如何安装 @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 和提交记录判断。