Installation

Quick Start (Recommended)

The all-in-one rilaykit package bundles core, forms, workflows, and the agent toolkit:

pnpm add rilaykit

npm install rilaykit

yarn add rilaykit

bun add rilaykit

Two entry points: the main entry is React-free (safe in Server Components); components and hooks come from rilaykit/react:

import { ril, required, when } from 'rilaykit';
import { Form, FormField, Flow } from 'rilaykit/react';

The ril instance exposes .form() and .flow() directly:

const r = ril.create().component('input', { renderer: renderInput });

const contactForm = r.form('contact')
  .add({ id: 'name', type: 'input', props: { label: 'Name' } })
  .build();

const onboarding = r.flow('onboarding', 'Onboarding')
  .step({ title: 'Step 1', formConfig: contactForm })
  .build();

AI adapters ship as sub-entries: rilaykit/ai-sdk (Vercel AI SDK, requires the optional ai >= 5 peer) and rilaykit/anthropic (requires @anthropic-ai/sdk).

Package Overview

Package	Description
`rilaykit`	Recommended — all-in-one, re-exports everything below plus the enhanced `ril`
`@rilaykit/core`	Engine: component catalog, types, validation, conditions
`@rilaykit/forms`	Form builder + React components
`@rilaykit/workflow`	Multi-step workflows: navigation, persistence, analytics
`@rilaykit/agent`	AI chat tools (`show_form` / `show_flow` / `show_component`) + AI SDK and Anthropic adapters

All packages are MIT-licensed. Each pairs a React-free main entry with a /react entry for components and hooks.

Modular Installation

@rilaykit/core is the required foundation:

pnpm add @rilaykit/core @rilaykit/forms                                     # forms only
pnpm add @rilaykit/core @rilaykit/forms @rilaykit/workflow                  # + workflows
pnpm add @rilaykit/core @rilaykit/forms @rilaykit/workflow @rilaykit/agent  # + agent

Validation Libraries

Any Standard Schema library works — no adapters:

pnpm add zod   # or valibot, arktype, ...

Requirements

React >= 18 (peer dependency)
TypeScript >= 5 recommended
ai >= 5 — optional peer, only needed for the rilaykit/ai-sdk adapter

Works with any React framework: Next.js (main entries are RSC-safe; /react entries ship 'use client'), Vite, Remix, and others.