Skip to content

Interface: RbacCliConfig<T> ​

Defined in: packages/cli/src/config.ts:11

T is the engine's typed names (see RbacTypeConfig): defineConfig infers it from rbac, so the names in seed are checked against them.

Type Parameters ​

Type ParameterDefault type
T extends RbacTypeConfigDefaultRbacTypes

Properties ​

PropertyTypeDescriptionDefined in
rbacRbac<T> | (() => Rbac<T> | Promise<Rbac<T>>)The Rbac instance (with your storage adapter) the CLI operates on — or a function returning it, so connections are only opened when a command runs.packages/cli/src/config.ts:16
seed?SyncDefinitions<T, DefaultGuardName<T>>Roles & permissions for rbac-evolution sync — the same shape as rbac.sync(): one definition, or an array of definitions (one per guard / team). With per-guard names, each block is checked against the names of its guard.packages/cli/src/config.ts:24
subjectType?stringDefault subject type for assign-role / give-permission (spatie's user model). Default: user.packages/cli/src/config.ts:18
teardown?() => void | Promise<void>Called after every command, e.g. to close the database connection.packages/cli/src/config.ts:26

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