@arkenv/nuxt

@arkenv/nuxt validates environment variables from a Nuxt module and hydrates public keys through Nitro runtimeConfig. This page is the subpath and option list. Setup recipes live in the Nuxt guide.

Flat arkenv(schema, { exposeToClient }) is the only call shape. Nested bags and expose / shared aliases were removed — see Migrating to v1.

Installation

Install the module next to the engine you write schemas with. The module does not bundle @arkenv/core or @arkenv/standard.

npm install @arkenv/core @arkenv/nuxt arktype

Or if you use Zod, Valibot, or another Standard Schema validator:

npm install @arkenv/standard @arkenv/nuxt

Subpaths

Subpath	Role
`.`	Runtime `arkenv`
`./module`	Nuxt module (`modules: ["@arkenv/nuxt/module"]`)
`./config`	`setupArkEnv` and config types
`./standard`	Standard Schema runtime
`./standard/module`	Standard Schema Nuxt module

Module setup

./nuxt.config.ts

export default defineNuxtConfig({
  modules: ["@arkenv/nuxt/module"],
});

Module options

These options live under arkenv in nuxt.config.

Option	Default	Meaning
`validate`	`true`	Validate during Nuxt build/dev
`schemaPath`	auto	Schema entry path
`logger` / `logLevel`	(none)	Logging controls

Schema

Use the default entry for a single schema file.

./env.ts

import arkenv from "@arkenv/nuxt";

export const env = arkenv({
  DATABASE_URL: "string",
  NUXT_PUBLIC_API_URL: "string",
});

For an optional client/server module split, see Client vs. server. Never import a server env module from client or Vue code.

Next steps

Nuxt framework guide

Quickstart, flat schema, and runtimeConfig hydration.