Overview
Understand what effect-auth provides and how its layers fit together.
effect-auth is a composable, Effect-native authentication toolkit for TypeScript. It provides typed authentication flows, HTTP operations, and runtime services without requiring every application to adopt the same routes or architecture.
Alpha
APIs, schemas, and migrations can change between releases. Pin effect-auth and Effect versions, review release notes, and test upgrades.
What you can assemble
| Area | Building blocks |
|---|---|
| Sign-in | Password, email OTP, magic links, passkeys, custom primary methods, and OAuth composition |
| Account security | TOTP, recovery codes, trusted devices, MFA, step-up, verification, login approval, and recovery |
| Sessions and access | Cookie sessions, guards, API keys, permissions, and tokens |
| Runtime capabilities | Storage contracts, cryptography, mail, rate limiting, policy, and typed errors |
The Feature Status page is the authoritative support boundary; feature guides explain setup and ownership.
Durable state is part of the design
Authentication depends on atomic, durable users, identities, credentials, sessions, challenges, and revocations. Pick the database and migration lifecycle before designing the UI.
| Storage path | Maintained support | Application owns |
|---|---|---|
| SQLite, including Cloudflare D1 | Focused direct Drizzle stores for all 42 tracked ports | Composition, migrations, backups, and recovery |
| PostgreSQL | Focused direct Drizzle stores for all 42 tracked ports | Database Layer, deployment, migrations, and recovery |
| Other databases | Public ORM-free store contracts | Correct atomicity, concurrency, schema, and full ops |
Read Storage before choosing a deployment shape; matching table columns alone is not a correct custom adapter.
Where should I start?
| Goal | Next page |
|---|---|
| Run a tested Cloudflare app end to end | Quick Start |
| Install packages or choose an adapter | Installation |
| Understand the reusable HTTP boundary | HTTP Operations |
| Select sign-in, MFA, or recovery features | Authentication |
| Design roles, scopes, and resource authorization | Permissions and Roles |
| Design storage or a custom adapter | Storage |
| Add one capability to an existing integration | Recipes |
| Evaluate production readiness | Production Checklist |