Skip to content

Installation ​

RBAC Evolution is split into a core package plus optional adapters and framework integrations. Install the core, then add what your stack needs.

Requirements

Node.js 20 or later. The core ships both ESM and CommonJS builds with TypeScript types.

1. Install the core ​

bash
npm i @anievo-id/rbac-evolution
bash
pnpm add @anievo-id/rbac-evolution
bash
yarn add @anievo-id/rbac-evolution
bash
bun add @anievo-id/rbac-evolution

The core already contains MemoryAdapter, which is enough for tests, prototypes and the quick start.

2. Pick a storage adapter ​

For real data, install the adapter for your ORM.

ORMPackagePeer dependency
Prisma@anievo-id/rbac-evolution-prisma@prisma/client 5.12+, 6 or 7
Drizzle@anievo-id/rbac-evolution-drizzledrizzle-orm 0.38+ (PostgreSQL or SQLite)
bash
npm i @anievo-id/rbac-evolution-prisma
# or
npm i @anievo-id/rbac-evolution-drizzle
bash
pnpm add @anievo-id/rbac-evolution-prisma
# or
pnpm add @anievo-id/rbac-evolution-drizzle
bash
yarn add @anievo-id/rbac-evolution-prisma
# or
yarn add @anievo-id/rbac-evolution-drizzle
bash
bun add @anievo-id/rbac-evolution-prisma
# or
bun add @anievo-id/rbac-evolution-drizzle

Each adapter needs a few tables. See Prisma or Drizzle for the schema, or write your own adapter for another database.

3. Pick framework integrations ​

All integrations are optional.

FrameworkPackagePeer dependency
Next.js@anievo-id/rbac-evolution-nextnext 14+, react 18+
React@anievo-id/rbac-evolution-reactreact 18+
Solid@anievo-id/rbac-evolution-solidsolid-js 1.8+ or 2.x
React Router@anievo-id/rbac-evolution-react-routerreact-router 7+ (or Remix 2)
Vue@anievo-id/rbac-evolution-vuevue 3.3+
SvelteKit@anievo-id/rbac-evolution-sveltekit@sveltejs/kit 2+, svelte 5+
TanStack Start@anievo-id/rbac-evolution-tanstack-start@tanstack/react-start or @tanstack/solid-start 1.x
Astro@anievo-id/rbac-evolution-astroastro 4+
Express@anievo-id/rbac-evolution-expressexpress 4+
Elysia@anievo-id/rbac-evolution-elysiaelysia 1.2+
tRPC@anievo-id/rbac-evolution-trpc@trpc/server 11+

For example, a Next.js app using Prisma:

bash
npm i @anievo-id/rbac-evolution @anievo-id/rbac-evolution-prisma @anievo-id/rbac-evolution-next @anievo-id/rbac-evolution-react
bash
pnpm add @anievo-id/rbac-evolution @anievo-id/rbac-evolution-prisma @anievo-id/rbac-evolution-next @anievo-id/rbac-evolution-react
bash
yarn add @anievo-id/rbac-evolution @anievo-id/rbac-evolution-prisma @anievo-id/rbac-evolution-next @anievo-id/rbac-evolution-react
bash
bun add @anievo-id/rbac-evolution @anievo-id/rbac-evolution-prisma @anievo-id/rbac-evolution-next @anievo-id/rbac-evolution-react

4. The CLI (optional) ​

The CLI is a dev tool, so install it as a dev dependency:

bash
npm i -D @anievo-id/rbac-evolution-cli
bash
pnpm add -D @anievo-id/rbac-evolution-cli
bash
yarn add -D @anievo-id/rbac-evolution-cli
bash
bun add -d @anievo-id/rbac-evolution-cli

See CLI for setup.

Create one instance ​

Create the engine once and import it wherever you need it:

ts
// lib/rbac.ts
import { createRbac } from '@anievo-id/rbac-evolution'
import { PrismaAdapter } from '@anievo-id/rbac-evolution-prisma'
import { prisma } from './prisma'

export const rbac = createRbac({ adapter: new PrismaAdapter(prisma) })

createRbac accepts these options:

OptionDefaultDescription
adapterrequiredWhere data is stored
defaultGuard'web'Guard used when none is given. See Multiple guards.
wildcardfalseEnable wildcard permissions
teamsfalseEnable teams
cachein-memoryA CacheStore, or false to disable caching
cacheTtl24 hoursCache TTL in milliseconds
beforenoneHook that runs before can() checks. See Super-admin.
superAdminRoles[]Roles that pass every can() check

Released under the MIT License. Inspired by spatie/laravel-permission.