Installation

Quick Start (Recommended)

The easiest way to get started is with the all-in-one rilaykit package. It includes core, forms, and workflows in a single install:

pnpm add rilaykit

npm install rilaykit

yarn add rilaykit

bun add rilaykit

Everything is available from a single import:

import { ril, Form, FormField, Workflow, required, when } from 'rilaykit';

The all-in-one package also adds convenience methods .form() and .flow() directly on the ril instance:

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

// Create forms directly from the ril instance
const myForm = r.form('contact')
  .add({ type: 'input', props: { label: 'Name' } })
  .build();

// Create workflows directly from the ril instance
const myFlow = r.flow('onboarding', 'Onboarding')
  .step({ title: 'Step 1', formConfig: myForm })
  .build();

Package Overview

Package	License	Description	Use Case
`rilaykit`	MIT	All-in-one package with enhanced API	Recommended - Everything you need
`@rilaykit/core`	MIT	Core engine, types, validation system	Modular install - foundation only
`@rilaykit/forms`	MIT	Form builder and React components	Modular install - forms only
`@rilaykit/workflow`	MIT	Multi-step workflows with advanced features	Modular install - workflows only

Modular Installation

If you prefer to install only the packages you need (for optimal tree-shaking), you can use the individual packages. @rilaykit/core is always required as the foundation.

Forms Only

pnpm add @rilaykit/core @rilaykit/forms

npm install @rilaykit/core @rilaykit/forms

yarn add @rilaykit/core @rilaykit/forms

bun add @rilaykit/core @rilaykit/forms

Forms + Workflows

pnpm add @rilaykit/core @rilaykit/forms @rilaykit/workflow

npm install @rilaykit/core @rilaykit/forms @rilaykit/workflow

yarn add @rilaykit/core @rilaykit/forms @rilaykit/workflow

bun add @rilaykit/core @rilaykit/forms @rilaykit/workflow

Validation Libraries

RilayKit supports any Standard Schema compatible validation library out of the box — no adapters needed:

# Universal validation with Standard Schema - no adapters needed!

# For Zod users (recommended)
pnpm add zod

# For Yup users
pnpm add yup

# For Joi users
pnpm add joi

# Or use any other Standard Schema compatible library
pnpm add valibot arktype # etc.

# Universal validation with Standard Schema - no adapters needed!

# For Zod users (recommended)
npm install zod

# For Yup users
npm install yup

# For Joi users
npm install joi

# Or use any other Standard Schema compatible library
npm install valibot arktype # etc.

# Universal validation with Standard Schema - no adapters needed!

# For Zod users (recommended)
yarn add zod

# For Yup users
yarn add yup

# For Joi users
yarn add joi

# Or use any other Standard Schema compatible library
yarn add valibot arktype # etc.

# Universal validation with Standard Schema - no adapters needed!

# For Zod users (recommended)
bun add zod

# For Yup users
bun add yup

# For Joi users
bun add joi

# Or use any other Standard Schema compatible library
bun add valibot arktype # etc.

System Requirements

RilayKit requires modern React and TypeScript versions for optimal type safety and performance.

Required Dependencies

{
  "peerDependencies": {
    "react": ">=18.0.0",
    "react-dom": ">=18.0.0"
  },
  "devDependencies": {
    "typescript": ">=5.0.0"
  }
}

Framework Compatibility

RilayKit works with any React-based framework:

Next.js (App Router & Pages Router)
Vite + React
Create React App (CRA)
Remix
Gatsby
Expo (React Native compatible)

Verification

Verify your installation by importing the package:

test-installation.tsx

import { ril, Form } from 'rilaykit';

// If this imports without errors, you're ready to go!
console.log('RilayKit is ready!');

Next Steps

New to RilayKit? → Start with Your First Form
Want to see examples? → Browse the Examples Gallery
Coming from another library? → Check our Standard Schema Migration Guide

Installation

On this page