Skip to content
Back to search

permix

🔒 Permix is a lightweight, framework-agnostic, type-safe permissions management library for TypeScript applications on the client and server sides.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/letstri--permix/badge.svg)](/listings/letstri--permix)

HTML

<a href="/listings/letstri--permix"><img src="/api/listings/letstri--permix/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 43 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

This file has changed since it was scanned, so this is not exactly the text that was scanned, and no line is marked. The findings are listed with the safety scan above.

  1. # Permix
  2. [![npm version](https://badge.fury.io/js/permix.svg)](https://npmjs.com/package/permix) ![You need Permix](https://img.shields.io/badge/You_need-Permix-purple)
  3. Permix is a lightweight, framework-agnostic, type-safe permissions management library for JavaScript applications on the client and server sides.
  4. ## Documentation
  5. You can find the documentation [here](https://permix.letstri.dev).
  6. ## Example
  7. To quick start you only need to write the following code:
  8. ```ts
  9. import { createPermix } from 'permix'
  10. const permix = createPermix<{
  11. post: ['read']
  12. }>()
  13. permix.setup({
  14. post: {
  15. read: true,
  16. },
  17. })
  18. permix.check('post.read') // true
  19. ```
  20. Permix has other powerful features, so here's check out the [docs](https://permix.letstri.dev/docs) or the [examples](https://github.com/letstri/permix/tree/main/examples) directory.
  21. ## AI agents
  22. Your agents know every permission in place: the whole permission model lives in one typed `createPermix<...>` schema, and any permission an agent invents, misspells, or forgets is a TypeScript error.
  23. - [Agent skills](permix/skills/README.md) ship inside the npm package — `npx skills add letstri/permix`, or copy them from `node_modules/permix/skills/` so they match your installed version.
  24. - LLM-friendly docs: [`llms.txt`](https://permix.letstri.dev/llms.txt), [`llms-full.txt`](https://permix.letstri.dev/llms-full.txt), and any docs page as Markdown by appending `.md` to its URL.
  25. - Prompts, `AGENTS.md` conventions, and gating in-app AI tools: [AI Agents guide](https://permix.letstri.dev/docs/agents).
  26. ## License
  27. MIT License - see the [LICENSE](https://github.com/letstri/permix/blob/main/LICENSE) file for details

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.