@sargonpiraev/env-docs

Generate .env.example (and optional README env docs) from Zod env schema maps that use .describe().

SSOT pattern: export raw serverSchema / clientSchema / sharedSchema objects from one env.ts, then:

• runtime: @t3-oss/env-nextjs / @t3-oss/env-core createEnv({ server, client, … })
• docs: this package walks those maps → KEY= lines + # description comments

Install

npm install -D @sargonpiraev/env-docs zod

Env module shape

import { createEnv } from '@t3-oss/env-nextjs'
import { z } from 'zod'

export const serverSchema = {
  DATABASE_URL: z.string().min(1).describe('Postgres connection URL'),
}

export const clientSchema = {
  NEXT_PUBLIC_SITE_URL: z.string().url().describe('Public site origin'),
}

export const env = createEnv({
  server: serverSchema,
  client: clientSchema,
  experimental__runtimeEnv: {
    NEXT_PUBLIC_SITE_URL: process.env.NEXT_PUBLIC_SITE_URL,
  },
  emptyStringAsUndefined: true,
  // Allow codegen to import this file without real env values
  skipValidation: process.env.ENV_DOCS_CODEGEN === '1',
})

TODO: howToGet / docsUrl via Zod .meta() — not implemented yet.

CLI

npx env-docs generate --module ./src/env.ts --out .env.example
npx env-docs generate --module ./src/env.ts --out .env.example --readme README.md

README injection uses markers:

<!-- env-docs -->
…
<!-- /env-docs -->

Library

import { renderEnvExample, generateEnvDocs } from '@sargonpiraev/env-docs'