Quick Start

Install Permix

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:

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:

// ...

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

Check permissions

After setup, you can use check method to check available permissions:

permix.check('post.create') // true

Finish

That's it! 🎉

You've now got a basic setup of Permix. Next, read the core guides:

• Instance — schema, ValidateDefinition, MergePermix, $inferPath
• Setup — rules, createRules, type-based callbacks
• Check — paths, ~all / ~any, errors
• Template — reusable role presets
• Hydration and Ready state — SSR and async bootstrap