installation

Install Duck Gen and generate your first types.

Prerequisites

  • Node 22 or newer.
  • A TypeScript project with a valid tsconfig.json.
  • NestJS (the only supported framework today).

Install the package

pnpm add -D @gentleduck/gen
pnpm add -D @gentleduck/gen

Create duck-gen.toml

duck-gen.toml
framework = "nestjs"
 
[extensions.shared]
sourceGlobs = ["src/**/*.ts", "src/**/*.tsx"]
tsconfigPath = "./tsconfig.json"
includeNodeModules = false
 
[extensions.apiRoutes]
enabled = true
globalPrefix = "/api"
normalizeAnyToUnknown = true
 
[extensions.messages]
enabled = true
duck-gen.toml
framework = "nestjs"
 
[extensions.shared]
sourceGlobs = ["src/**/*.ts", "src/**/*.tsx"]
tsconfigPath = "./tsconfig.json"
includeNodeModules = false
 
[extensions.apiRoutes]
enabled = true
globalPrefix = "/api"
normalizeAnyToUnknown = true
 
[extensions.messages]
enabled = true

Run the generator

pnpm exec duck-gen
pnpm exec duck-gen

Read the core guide

Head to Duck Gen core for configuration details, output paths, and troubleshooting.