# Docs

- [Introduction](/docs): Welcome to the ArkEnv documentation!
- [Why ArkEnv?](/docs/why-arkenv): See how ArkEnv compares to other environment variable validation libraries and techniques.
- Getting started
  - [Getting started](/docs/getting-started): Get started with ArkEnv.
  - [Installation](/docs/getting-started/installation): Install ArkEnv with the CLI or by hand in a new or existing project.
  - [Start with an example](/docs/getting-started/examples): Start with an example ArkEnv project.
  - [Editor integration](/docs/getting-started/editor-integration): Configure autocomplete, type inspection, and diagnostics in your editor.
- Core concepts
  - [Core concepts](/docs/core-concepts): Design, parse, and secure environment variables with ArkEnv.
  - [Defining your schema](/docs/core-concepts/defining-your-schema): Put env.ts in place, declare field types, and fail fast with a typed env object.
  - [Client vs. server](/docs/core-concepts/client-vs-server): Keep public env keys out of private secrets and off the browser bundle.
  - [Coercion and parsing](/docs/core-concepts/coercion-and-parsing): Turn string environment variables into numbers, booleans, arrays, and objects.
  - [Error reporting](/docs/core-concepts/error-reporting): Fail fast on invalid env with clear console output and structured issues.
  - [Reusing schemas](/docs/core-concepts/reusing-schemas): Define a schema once and validate it across runtimes and packages.
  - [Hosting presets](/docs/core-concepts/hosting-presets): Pre-populate schemas with Vercel, Netlify, Cloudflare, Railway, Render, or Fly.io environment variables.
- Frameworks
  - [Frameworks](/docs/frameworks): Validate environment variables in Next.js, Nuxt, Vite, TanStack Start, and Bun with ArkEnv.
  - [Next.js](/docs/frameworks/nextjs): Learn how to use ArkEnv in a Next.js project.
  - [Nuxt](/docs/frameworks/nuxt): Learn how to use ArkEnv in a Nuxt project.
  - [Vite](/docs/frameworks/vite): Learn how to use ArkEnv in a Vite project.
  - [TanStack Start](/docs/frameworks/tanstack-start): Learn how to use ArkEnv in a TanStack Start project.
  - [Bun fullstack dev server](/docs/frameworks/bun): Learn how to use ArkEnv in a Bun fullstack application.
- Validators
  - [Validators](/docs/validators): Choose between @arkenv/core and @arkenv/standard, then wire ArkType, Zod, or Valibot.
  - [ArkType](/docs/validators/arktype): Validate environment variables with @arkenv/core and ArkType.
  - [Zod](/docs/validators/zod): Validate environment variables with your existing Zod schemas.
  - [Valibot](/docs/validators/valibot): Validate environment variables with @arkenv/standard/valibot.
- Guides
  - [Guides](/docs/guides): AI tooling and migration paths for ArkEnv.
  - [Using AI with ArkEnv](/docs/guides/ai): Get the most out of AI coding assistants with ArkEnv.
  - [Use with NestJS](/docs/guides/use-with-nestjs): Validate and type environment variables in NestJS with a fail-fast env module.
  - [Migrating to v1](/docs/guides/migrating-to-v1): Move a v0 project to the v1 packages and the canonical env object.
  - [Migrating from T3 Env](/docs/guides/migrating-from-t3-env): Replace createEnv and runtimeEnv with a flat ArkEnv schema.
  - [Migrating from a getEnv helper](/docs/guides/migrating-from-a-getenv-helper): Graduate from a 12-line presence check helper to typed coercion and boundary enforcement.
- API reference
  - [API reference](/docs/reference): API, CLI, and package export reference.

  - **Configuration**
  - [options](/docs/reference/options): Configuration object passed as the second argument to arkenv().
  - [keywords](/docs/reference/keywords): ArkEnv keywords that extend ArkType for common environment shapes.
  - [schema](/docs/reference/schema): Schema shapes accepted by arkenv() in core and standard modes.
  - [env](/docs/reference/env): The validated env object returned by arkenv().

  - **Commands**
  - [init](/docs/reference/init): CLI flags and output for arkenv init.
  - [check](/docs/reference/check): Validate environment variables against the schema with CI-friendly exit codes.

  - **Packages**
  - [@arkenv/core](/docs/reference/core): ArkType-powered environment validation for TypeScript projects.
  - [@arkenv/standard](/docs/reference/standard): ArkType-free environment validation via Standard Schema.
  - [@arkenv/nextjs](/docs/reference/nextjs): Next.js integration framework for ArkEnv.
  - [@arkenv/nuxt](/docs/reference/nuxt): Subpath exports and module options for the Nuxt package.
  - [@arkenv/vite-plugin](/docs/reference/vite-plugin): Exports and transform options for the Vite plugin.
  - [@arkenv/rsbuild-plugin](/docs/reference/rsbuild-plugin): Exports and transform options for the Rsbuild plugin.
  - [@arkenv/bun-plugin](/docs/reference/bun-plugin): Exports and transform options for the Bun plugin.
  - [@arkenv/agent-plugin](/docs/reference/agent-plugin): Coding-agent plugin and MCP server for init and env audits.
- [Community](/docs/community): Connect with the ArkEnv community, ask questions, and contribute.
- [Changelog](https://github.com/yamcodes/arkenv/releases)