@arkenv/rsbuild-plugin

API reference for @arkenv/rsbuild-plugin. Setup recipes: TanStack Start guide.

Installation

npm install -D @arkenv/rsbuild-plugin
npm install @arkenv/core arktype

pnpm add -D @arkenv/rsbuild-plugin
pnpm add @arkenv/core arktype

yarn add --dev @arkenv/rsbuild-plugin
yarn add @arkenv/core arktype

bun install --dev @arkenv/rsbuild-plugin
bun install @arkenv/core arktype

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

npm install -D @arkenv/rsbuild-plugin
npm install @arkenv/standard

pnpm add -D @arkenv/rsbuild-plugin
pnpm add @arkenv/standard

yarn add --dev @arkenv/rsbuild-plugin
yarn add @arkenv/standard

bun install --dev @arkenv/rsbuild-plugin
bun install @arkenv/standard

Exports

Export	Role
default	`arkenvPlugin` plugin factory
named `arkenvPlugin`	Plugin factory
named `arkenvRsbuildPlugin`	Host-explicit named alias
`./standard`	Standard Schema plugin entry

Transform options

Pass transform options only. A schema argument is rejected.

Option	Default	Meaning
`schemaPath`	auto (`env.ts`)	Schema module to transform
`clientPrefix`	`PUBLIC_`	Keys exposed to the client
Plus	(none)	All `ArkEnvConfig` fields except `safe`
`logger` / `logLevel`	(none)	Logging

Call arkenvPlugin() (or arkenvRsbuildPlugin()) with no args, or an options object that includes transform fields (schemaPath, clientPrefix, logging). Do not pass a schema map or compiled type() to the plugin.

Next steps

TanStack Start framework guide

Setup recipes for Vite and Rsbuild, server functions, and client boundary.