Installation

Install the package

npm

npm install @usebetterdev/audit

pnpm

pnpm add @usebetterdev/audit

yarn

yarn add @usebetterdev/audit

bun

bun add @usebetterdev/audit

The main package (@usebetterdev/audit) includes the core library and all adapters via subpath exports. The CLI (@usebetterdev/audit-cli) is used via npx for generating migrations and managing audit data — no installation required.

Peer dependencies

You need a database driver and (optionally) a framework. Install the ones you use:

ORM adapter

Drizzle + pg

npm install drizzle-orm pg

import { drizzleAuditAdapter, withAuditProxy } from "@usebetterdev/audit/drizzle";

Drizzle + postgres.js

npm install drizzle-orm postgres

import { drizzleAuditAdapter, withAuditProxy } from "@usebetterdev/audit/drizzle";

Drizzle + better-sqlite3

npm install drizzle-orm better-sqlite3

import { drizzleAuditAdapter, withAuditProxy } from "@usebetterdev/audit/drizzle";

Prisma

npm install @prisma/client

Requires @prisma/client >= 5.0.0.

import { prismaAuditAdapter, withAuditExtension } from "@usebetterdev/audit/prisma";

Framework adapter

Hono

npm install hono

Requires hono >= 4.

import { betterAuditHono } from "@usebetterdev/audit/hono";

Express

npm install express

Requires express >= 4.

import { betterAuditExpress } from "@usebetterdev/audit/express";

Next.js

npm install next

Requires next >= 14.

import { createAuditMiddleware, withAuditRoute, withAudit } from "@usebetterdev/audit/next";

Requirements

• Node.js 22+ (also supports Bun and Deno)
• PostgreSQL 13+, MySQL, or SQLite
• TypeScript 5+ (recommended, but not required)

Subpath exports

All adapters are available through the umbrella package via subpath exports:

import { betterAudit, getAuditContext, fromBearerToken, fromHeader, fromCookie } from "@usebetterdev/audit";
import { drizzleAuditAdapter, withAuditProxy, auditLogs } from "@usebetterdev/audit/drizzle";
import { prismaAuditAdapter, withAuditExtension } from "@usebetterdev/audit/prisma";
import { betterAuditHono } from "@usebetterdev/audit/hono";
import { betterAuditExpress } from "@usebetterdev/audit/express";
import { createAuditMiddleware, withAuditRoute, withAudit, AUDIT_ACTOR_HEADER } from "@usebetterdev/audit/next";

Next steps

• Quick Start — wire up audit logging in your app