README.md

@cerbos/files

Load Cerbos policies from YAML or JSON files.

Prerequisites

• Node.js 18+

Installation

$ npm install @cerbos/files

Example usage

import { readDirectory, readPolicy, readSchema } from "@cerbos/files";

const policy = await readPolicy("path/to/policy.yaml");
// => { apiVersion: "api.cerbos.dev/v1", ... }

const schema = await readSchema("_schemas/path/to/schema.json");
// => { id: "path/to/schema.json", definition: "..." }

const { policies, schemas } = await readDirectory("path/to/directory");
// => { policies: [...], schemas: [...] }

For more details, see the package documentation.

Further reading

• API reference
• Cerbos documentation

Get help

• Join the Cerbos community on Slack
• Email us at help@cerbos.dev