Reference
Lookup reference for Better IAM - every betterIam() option, API method, export, type, CLI command, error code, package, and term - plus the FAQ, contributing guide, and changelog.
The Reference section is for looking things up: exact names, signatures, routes, defaults, and codes. Most of it
is generated from the repository by apps/docs/scripts/generate.mjs, so it matches the code it documents: method
names and signatures come from the built TypeScript declarations and a live betterIam() instance, error codes from
every IamError thrown in packages/*/src, CLI usage from the CLI's own help text, and packages from the workspace
manifests. The Options page is written from packages/server/src/options.ts and the option types it imports.
Pages in this section
| Page | What it contains | Source |
|---|---|---|
| Options | Every option betterIam() accepts, with type, default, range, and example | packages/server/src/options.ts |
| Server API | Every iam.api group and method with its HTTP route, credential, and signature | generated |
| Package exports | Every function, hook, component, class, and constant the packages export | generated |
| Types | The core TypeScript types and their fields | generated |
| CLI | Every better-iam command and its flags | generated |
| Error codes | Every stable IamError code, grouped by HTTP status | generated |
| Glossary | Plain-language definitions of identity and access terms | descriptions/glossary.json |
| Packages | The publishable packages, subpath exports, and dependencies | generated |
| FAQ | Short answers about adopting, running, migrating, databases, and AI | hand-written |
| Contributing | Repository layout, build and test commands, docs generation, CI | hand-written |
| Changelog | Every notable change, newest first | CHANGELOG.md |
Every betterIam() option, grouped by area, with its type, default, allowed range, and an example.
Every iam.api group and method with its HTTP route, credential requirement, and TypeScript signature.
Every function, hook, component, and class the packages export, what it does, and the guide that uses it.
TypesThe core TypeScript types of Better IAM and their exact fields.
CLIThe better-iam command line: migrations, bootstrap, audits, configuration as code, and scheduled jobs.
Every stable IamError code grouped by HTTP status, with example messages.
Definitions of the identity and access terms used throughout the docs.
PackagesThe publishable packages, their subpath exports, and dependencies.
FAQShort answers about adopting, running, migrating to, and upgrading Better IAM.
ContributingSet up the repository, run the tests and conformance checks, and regenerate the docs.
ChangelogEvery notable change, newest first.
Machine-readable docs
The site serves its content for tools and language models as well as for people:
| URL | Content |
|---|---|
/llms.txt | An index of every page with its description |
/llms-full.txt | Every page as Markdown in one file |
/skills/better-iam/SKILL.md | An agent skill for coding agents (Agent skills) |
/docs/<page>.md | One page as Markdown (also served for Accept: text/markdown) |
/api/search?query=… | The search index behind the search dialog, as JSON |
/api/mcp | An MCP server with search, page, API-method, export, and error-code tools; see Use the docs with AI |
/openapi.json | The OpenAPI 3.1 description of the HTTP API |
Regenerating
pnpm build # declarations the API catalog is read from
pnpm --filter @better-iam/docs generate # data + generated pages (API, exports, errors, CLI, glossary)
node apps/docs/scripts/check-content.mjs # validate every page and linkSee Contributing for every generator step.
Better IAM is created by Sean Filimon
Last updated
Prompts and AGENTS.md
Copyable prompts that point AI coding agents at the right Better IAM docs for setup, permission checks, roles, debugging, reviews, migration, and upgrades, plus an AGENTS.md block for your repository.
Options
Every option betterIam() accepts, grouped by area, with its type, default, allowed range, and a short example, read from the server's option types.