README.md

@vlandoss/env

🌱 Contract-first environment configuration with typed schemas. Define your env once with Standard Schema (Zod, Valibot, ArkType…), get a fully typed env object that merges per-environment config with your environment variables.

Runtime-agnostic core — Node, Bun, Deno, browser, Workers, Edge. Opt-in entry points: a filesystem-based config loader (works on Node, Bun, and Deno), a Vite plugin, a React <EnvScript /> helper for hydrating runtime env across SSR or CSR, and a curated set of Zod-based schema primitives.

Installation

pnpm add @vlandoss/env

@vlandoss/env is agnostic to the schema validator. If you'll use Zod (the docs default, and the validator behind the optional @vlandoss/env/zod primitives), install it alongside:

pnpm add zod

Documentation

📚 env.oss.variable.land

• Getting started
• Concepts — mental model, resolution order, env-var naming
• Guides — recipes for Node, SPA, SSR
• API reference

Examples

Runnable apps under examples/:

• backend-node — Node server with loadConfig
• backend-bun — Bun server with loadConfig
• backend-deno — Deno server with loadConfig
• worker-cloudflare — Cloudflare Worker, runtimeEnv: c.env per-request
• edge-nextjs — Next.js App Router route handler with runtime: 'edge'
• spa-vite-dynamic — SPA, dynamic import pattern
• spa-vite-plugin — SPA, #config alias
• ssr-react-router — SSR with React Router 7
• ssr-tanstack-start — SSR with TanStack Start

License

MIT