Installation

RilayKit is modular by design. Install only the packages you need. @rilaykit/core is always required as the foundation.

Quick Start

For most use cases, start with the core and forms packages:

pnpm add @rilaykit/core @rilaykit/forms

npm install @rilaykit/core @rilaykit/forms

yarn add @rilaykit/core @rilaykit/forms

bun add @rilaykit/core @rilaykit/forms

Package Overview

Package	License	Description	Use Case
`@rilaykit/core`	MIT	Core engine, types, validation system	Required - Foundation for all RilayKit usage
`@rilaykit/forms`	MIT	Form builder and React components	Single-page forms, basic workflows
`@rilaykit/workflow`	Commercial	Multi-step workflows with advanced features	Complex onboarding, multi-page forms, analytics
`@rilaykit/validation-adapters`	MIT	Zod, Yup, and Joi integrations	When using external validation libraries

Advanced Installation

Multi-Step Workflows

For complex workflows with step navigation, persistence, and analytics:

@rilaykit/workflow requires a commercial license for production use.

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 Adapters

If you prefer using established validation libraries:

# For Zod users (recommended)
pnpm add @rilaykit/validation-adapters zod

# For Yup users
pnpm add @rilaykit/validation-adapters yup

# For Joi users
pnpm add @rilaykit/validation-adapters joi

# For Zod users (recommended)
npm install @rilaykit/validation-adapters zod

# For Yup users
npm install @rilaykit/validation-adapters yup

# For Joi users
npm install @rilaykit/validation-adapters joi

# For Zod users (recommended)
yarn add @rilaykit/validation-adapters zod

# For Yup users
yarn add @rilaykit/validation-adapters yup

# For Joi users
yarn add @rilaykit/validation-adapters joi

# For Zod users (recommended)
bun add @rilaykit/validation-adapters zod

# For Yup users
bun add @rilaykit/validation-adapters yup

# For Joi users
bun add @rilaykit/validation-adapters joi

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 core package:

test-installation.tsx

import { ril } from '@rilaykit/core';
import { Form } from '@rilaykit/forms';

// 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 Migration Guides
Enterprise setup? → Review Configuration Best Practices

Installation

On this page