Permix - Type-safe permissions management for JavaScript

Try Permix

Want to explore Permix before installing? Try our interactive sandbox environment where you can experiment with type-safe permissions management right in your browser.

Try Permix Sandbox

Installation via Agents

Using Claude Code, Cursor, or another agent that supports skills? Add Permix skills, then hand it this prompt to set up permissions for you:

npx skills add letstri/permix

Install and set up a base Permix architecture for this project.

1. Detect my stack (framework(s), server/client split, e.g. React, Vue, Solid,
   Svelte, Next.js, TanStack Start, Node, Hono, Express, tRPC, oRPC, Fastify,
   Elysia, Drizzle) and install `permix` plus the matching integration
   package(s) from https://permix.letstri.dev/docs.
2. Scan the codebase for my real resources/entities (DB models, API routes,
   UI sections) and design a `createPermix<...>` schema from them instead of
   placeholder data.
3. Wire `permix.setup()` with actual rules for those resources, driven by my
   auth/session/role data wherever it already exists.
4. Add server-side checks (middleware) on the matching integration and
   client-side checks/guards in the relevant components or routes.
5. Follow the getting-started, setup, template, and framework integration
   guides in the Permix skill for conventions and API shape.

Or continue with the manual installation below.

Installation

Install a package

Typically you'll need to install Permix using your package manager:

npm install permix

Create an instance

To create a base instance, you need to provide a schema as a generic type to createPermix function that defines your permissions:

/lib/permix.ts

import { createPermix } from 'permix'

export const permix = createPermix<{
  post: ['create', 'read', 'update', 'delete']
}>()

// ...

Learn more about features and configuration of instances in the instance guide.

Setup your permissions

You can setup your permissions by calling setup method on your instance in any place you want:

/lib/permix.ts

// ...

// Call setupPermissions in your application
export function setupPermissions() {
  permix.setup({
    post: {
      create: true,
      read: true,
      update: true,
      delete: false,
    },
  })
}