Installation

Prerequisites

Required

• Vue 3.3+.
• Typescript 4.8+.
  • Compatible with plain javascript.
• Text Editor with Vue syntax support.
  • VSCode is recommended, along with the official Vue extension.

Optional

• Nuxt
  • Nuxt 3.1+, and check docs for Nuxt module
• Pinia
  • Pinia 2.2.5+

Schema libraries: Docs

• Zod 3.24+.
• Valibot 1+.
• ArkType 2+
• Any library using the Standard Schema Spec

pnpm

pnpm add @regle/core @regle/rules

npm

npm install @regle/core @regle/rules

yarn

yarn add @regle/core @regle/rules

bun

bun add @regle/core @regle/rules

Devtools

To enable devtools, you need to install the Regle plugin in your app.

TIP

If you use the @regle/nuxt module, the devtools will be automatically enabled.

main.ts

import { createApp } from 'vue';
import { RegleVuePlugin } from '@regle/core';
import App from './App.vue';

const app = createApp(App);

app.use(RegleVuePlugin); // <--

app.mount('#app');