Agent Skills › victorgarciaesgi/regle › regle

regle

GitHub

Vue 3 表单验证技能，涵盖 Regle 库的安装、核心 API 使用及响应式状态管理。适用于添加或编辑 Vue 表单、绑定 v-model 及处理验证错误场景。

skills/regle/SKILL.md victorgarciaesgi/regle

Trigger Scenarios

在 Vue 3 项目中实现表单验证配置 Regle 库的 useRegle 和 r$ 对象处理表单字段的状态与错误显示

Install

npx skills add victorgarciaesgi/regle --skill regle -g -y

More Options

Use without installing

npx skills use victorgarciaesgi/regle@regle

指定 Agent (Claude Code)

npx skills add victorgarciaesgi/regle --skill regle -a claude-code -g -y

安装 repo 全部 skill

npx skills add victorgarciaesgi/regle --all -g -y

预览 repo 内 skill

npx skills add victorgarciaesgi/regle --list

SKILL.md

Frontmatter

{
    "name": "regle",
    "license": "MIT",
    "metadata": {
        "author": "Victor Garcia",
        "source": "https:\/\/reglejs.dev",
        "version": "1.27.0"
    },
    "description": "Core Regle form validation in Vue 3 — setup with `useRegle`, the reactive `r$` object, validation properties, displaying errors, and modifiers. Use when adding or editing Regle forms, binding `v-model` to `r$.$value`, or reading `$error`\/`$errors`\/`$invalid`\/`$validate`\/`$reset`. For validation rules see regle-rules; for advanced patterns see regle-advanced.",
    "compatibility": "Requires Vue 3.3+ and TypeScript 5.1+. Works with any agent supporting the Agent Skills spec."
}

Regle

Regle is a type-safe, model-based, headless form validation library for Vue 3. It provides full TypeScript inference, reactive validation, and works with any UI framework or design system.

MCP Server

Regle provides an MCP server that can be used to get documentation and autocomplete for Regle. If it's available, use it to get up-to-date information on the API.

{
  "mcpServers": {
    "regle": {
      "command": "npx",
      "args": ["@regle/mcp-server"]
    }
  }
}

## Installation

```sh
# Core + built-in rules
pnpm add @regle/core @regle/rules

# Optional: schema support (Zod, Valibot, ArkType)
pnpm add @regle/schemas

Requires Vue 3.3+ and TypeScript 5.1+.

Quick Start

import { useRegle } from '@regle/core';
import { required, email, minLength } from '@regle/rules';

const { r$ } = useRegle(
  { name: '', email: '' },
  {
    name: { required, minLength: minLength(3) },
    email: { required, email },
  }
);

<template>
  <input v-model="r$.$value.name" placeholder="Name" />
  <ul v-if="r$.$errors.name.length">
    <li v-for="error of r$.$errors.name" :key="error">{{ error }}</li>
  </ul>

  <button @click="r$.$validate()">Submit</button>
</template>

Key Concepts

State: first argument -- raw object, reactive, ref, or single value
Rules: second argument -- mirrors the data structure, each field gets a rules object
r$: returned reactive object with values, errors, dirty state, and validation methods
All rules are optional by default; add required to enforce a field

Core

Topic	Description	Reference
useRegle	State definition, rules declaration, dynamic rules, `r$` object	core-use-regle
Validation Properties	`$invalid`, `$dirty`, `$error`, `$errors`, `$pending`, `$validate`, `$touch`, `$reset`	core-validation-properties
Displaying Errors	Showing errors, custom messages, `getErrors`, `flatErrors`	core-displaying-errors
Modifiers	`autoDirty`, `lazy`, `silent`, `rewardEarly`, `disabled`, `validationGroups`, per-field modifiers	core-modifiers

Related skills

regle-rules — built-in rules, custom rules (createRule), rule wrappers (withMessage, withParams, withAsync), and rule operators (and, or, applyIf, assignIf).
regle-advanced — collections, async, server errors, reset, scoped validation, variants, global config.
regle-schemas — Zod, Valibot, ArkType, and Standard Schema integration.
regle-typescript — type-safe output, typing rules schemas and component props.