Start with an example

Explore our collection of examples to get familiar with ArkEnv.

Use the ArkEnv CLI to bootstrap an example with your favorite tooling.

npx @arkenv/cli@latest init --example <example-name>
pnx @arkenv/cli@latest init --example <example-name>
yarn dlx @arkenv/cli@latest init --example <example-name>
bunx @arkenv/cli@latest init --example <example-name>

Examples

NameDescription
basicMinimal example of using ArkEnv in a Node.js app for learning the fundamentals.
with-nextjsMinimal example of using ArkEnv in a Next.js app (Simple layout).
with-nextjs-strictMinimal example of using ArkEnv in a Next.js app (Strict split 3-file layout).
with-nuxtMinimal example of using ArkEnv in a Nuxt app.
with-vite-reactMinimal example of using ArkEnv in a Vite + React app.
with-bunMinimal example of using ArkEnv in a Bun app.
with-bun-reactMinimal example of using ArkEnv in a Bun + React full-stack app.
with-solid-startMinimal example of using ArkEnv in a SolidStart app.
with-zodExample of using ArkEnv with Zod for validation (without ArkType).
with-standard-schemaExample of mixing ArkType with Standard Schema validators like Zod.

These examples are written in TypeScript, the recommended way to work with ArkEnv. That said, ArkEnv works with plain JavaScript. See the basic-js example for details and tradeoffs.

Next steps

On this page