Regle

What it does

When your agent uses it

• Editing Regle forms
• Binding v-model to r$.$value
• Reading $error/$errors/$invalid/$validate/$reset

Example prompts

• “/regle”

Requirements

• Compatibility (from SKILL.md): Requires Vue 3.3+ and TypeScript 5.1+. Works with any agent supporting the Agent Skills spec.

What it can do on your machine

Read from SKILL.md and the folder at commit 9d69771. It shows what the files ask for, not the result of running them.

• Tool permissions

  Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

  From allowed-tools in the SKILL.md frontmatter.

• Runs code

  No scripts in the folder and no shell commands in SKILL.md (its code samples are json, typescript and vue).

  From the folder's file list and the shell code blocks in SKILL.md.

• Network

  No URLs in SKILL.md.

  From URLs in SKILL.md, links to its own repository left out.

• Credentials

  Names no API keys, tokens, secrets or passwords.

  From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

• Compatibility

  Requires Vue 3.3+ and TypeScript 5.1+. Works with any agent supporting the Agent Skills spec.

  From compatibility in the SKILL.md frontmatter.

Context cost

Regle loads about 840 tokens when it runs, and up to ~3.7k if it reads all its reference files. Until then it costs about 92 tokens; SKILL.md has 208 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it

~92

When it runs · the whole SKILL.md, loaded when a task matches

~840

With references · SKILL.md plus every file in references/, read only if the agent opens them

~3.7k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from victorgarciaesgi/regle at commit 9d69771, republished under its MIT licence (© victorgarciaesgi). 208 words, ~840 tokens.

name

regle

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.

license

MIT

metadata.author

Victor Garcia

metadata.version

1.27.0

metadata.source

https://reglejs.dev

{
  "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

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>

© victorgarciaesgi, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 4 other files (references) in skills/regle of victorgarciaesgi/regle.

• SKILL.md
• references/core-displaying-errors.md
• references/core-modifiers.md
• references/core-use-regle.md
• references/core-validation-properties.md

Open the folder on GitHubat commit 9d69771