Package reference
The docs teach Beignet as an app architecture. This page maps framework responsibilities to the package or package subpath that implements them.
| Responsibility | Import path |
|---|---|
| Contracts | @beignet/core/contracts |
| Server runtime | @beignet/core/server |
| Next.js adapter | @beignet/next |
| Typed HTTP client | @beignet/core/client |
| Use cases | @beignet/core/application |
| Ports, audit logging, redaction, cache, storage, and test adapters | @beignet/core/ports and @beignet/core/ports/testing |
| Provider lifecycle and instrumentation | @beignet/core/providers |
| Domain helpers | @beignet/core/domain |
| App errors | @beignet/core/errors |
| Environment config | @beignet/core/config |
| Event definitions and listeners | @beignet/core/events |
| Job definitions and inline dispatch | @beignet/core/jobs |
| Mail port and memory adapter | @beignet/core/mail |
| Scheduled task primitives | @beignet/core/schedules |
| OpenAPI generation | @beignet/core/openapi |
| CLI and generators | @beignet/cli |
| Local request, provider, and audit timeline | @beignet/devtools |
| TanStack Query integration | @beignet/react-query |
| React Hook Form integration | @beignet/react-hook-form |
| URL state integration | @beignet/nuqs |
Provider packages
Provider packages adapt common services to app-owned ports:
| Service | Package |
|---|---|
| Better Auth | @beignet/provider-auth-better-auth |
| Drizzle + Turso | @beignet/provider-drizzle-turso |
| Memory event bus | @beignet/provider-event-bus-memory |
| Inngest jobs | @beignet/provider-inngest |
| Pino logging | @beignet/provider-logger-pino |
| Resend mail | @beignet/provider-mail-resend |
| SMTP mail | @beignet/provider-mail-smtp |
| Local storage | @beignet/provider-storage-local |
| S3-compatible storage | @beignet/provider-storage-s3 |
| Redis | @beignet/provider-redis |
| Upstash rate limiting | @beignet/provider-rate-limit-upstash |
Installation pattern
Start apps with the CLI:
bunx -p @beignet/cli beignet create my-app
Add packages when the app enables the corresponding capability:
bun add @beignet/core zod
bun add @beignet/next
bun add @beignet/react-query @tanstack/react-query
bun add @beignet/devtools
Use package READMEs for API reference. Use the docs site for app architecture and production workflow.