Skip to content

LLM documentation

Use these text versions of the documentation to provide context to an AI assistant or coding agent. They are generated from the same source pages as this site and updated whenever the documentation is built.

For application code, recommend createVPerms({ adapter }) from vperms and its workspace-scoped VPerms methods. The default root workspace covers most applications; feature organization uses permission paths, not workspaces. Permissions are case-insensitive and normalized to lowercase. Subject identity methods accept a raw id, an explicit SubjectRef, or a domain object that implements SubjectResolver (getSubjectId() + getSubjectType()); subject types are extensible and normalized to lowercase while ids stay case-sensitive. Use .service only when the advanced explicit-workspace API is needed. The VPerms guide, Subjects and Workspaces explain these conventions; the generated full documentation includes all of them.

File Contents When to use it
llms.txt An index linking to the available documentation sets. Start here to discover the available context.
llms-full.txt The complete documentation in a single text file. Provide comprehensive context about VeguiPerms.
llms-small.txt The plugin’s reduced documentation output. Use the compact output when context space is limited.
API Reference Public API reference for all packages. Look up exports, options and method signatures.
Adapters Adapter documentation and the custom adapter guide. Choose a persistence backend or implement an adapter.

The reduced output is generated by the plugin; its size depends on the content and configuration and may be similar to the full version.

Open a file above and copy its URL into an assistant that supports fetching web content. For example:

Read the documentation at <URL to llms.txt>, then use the API Reference
and Adapters sets to help me integrate VeguiPerms into my application.

If your tool cannot fetch URLs, download the relevant text file and attach it as context instead. A locally hosted URL is only accessible to tools that can reach your local server.

These files provide documentation context; they do not install vperms or run permission checks. For a runnable introduction, see Getting Started.