T3 Env

Framework agnostic validation for type-safe environment variables

ConfigurationValidation
t3-oss/t3-envenv.t3.gg@t3-oss/env-core

README

Typesafe Envs made Simple


Deploying your app with invalid environment variables is a hassle. This package helps you to avoid that.

Installation


  1. ```bash
  2. # Core package, no framework specific features
  3. pnpm add @t3-oss/env-core zod
  4. # or, with options preconfigured for Next.js
  5. pnpm add @t3-oss/env-nextjs zod
  6. ```

Currently only supports Zod (which you'll need to install separately). Bring your own validation library is on the roadmap.


Usage


For full documentation, see https://env.t3.gg


This package supports the full power of Zod, meaning you can use transforms and default values.

Define your schema


  1. ```ts
  2. // src/env.mjs
  3. import { createEnv } from "@t3-oss/env-nextjs";
  4. import { z } from "zod";

  6. export const env = createEnv({
  7.   /*
  8.    * Serverside Environment variables, not available on the client.
  9.    * Will throw if you access these variables on the client.
  10.    */
  11.   server: {
  12.     DATABASE_URL: z.string().url(),
  13.     OPEN_AI_API_KEY: z.string().min(1),
  14.   },
  15.   /*
  16.    * Environment variables available on the client (and server).
  17.    *
  18.    * 💡 You'll get typeerrors if these are not prefixed with NEXT_PUBLIC_.
  19.    */
  20.   client: {
  21.     NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY: z.string().min(1),
  22.   },
  23.   /*
  24.    * Due to how Next.js bundles environment variables on Edge and Client,
  25.    * we need to manually destructure them to make sure all are included in bundle.
  26.    *
  27.    * 💡 You'll get typeerrors if not all variables from `server` & `client` are included here.
  28.    */
  29.   runtimeEnv: {
  30.     DATABASE_URL: process.env.DATABASE_URL,
  31.     OPEN_AI_API_KEY: process.env.OPEN_AI_API_KEY,
  32.     NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY:
  33.       process.env.NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY,
  34.   },
  35. });
  36. ```

Use said schema in your app with autocompletion and type inference


  1. ```ts
  2. // src/app/hello/route.ts
  3. import { env } from "../env.mjs";

  5. export const GET = (req: Request) => {
  6.   const DATABASE_URL = env.DATABASE_URL;
  7.   // use it...
  8. };
  9. ```

Roadmap


- [ ] Bring your own validation library - currently only supports Zod.