Get the FREE Ultimate OpenClaw Setup Guide →

better-auth

npx machina-cli add skill zircote/agents/better-auth --openclaw
Files (1)
SKILL.md
8.3 KB

Better Auth Skill

Better Auth is comprehensive, framework-agnostic authentication/authorization framework for TypeScript with built-in email/password, social OAuth, and powerful plugin ecosystem for advanced features.

<triggers> <trigger>Implementing auth in TypeScript/JavaScript applications</trigger> <trigger>Adding email/password or social OAuth authentication</trigger> <trigger>Setting up 2FA, passkeys, magic links, advanced auth features</trigger> <trigger>Building multi-tenant apps with organization support</trigger> <trigger>Managing sessions and user lifecycle</trigger> <trigger>Working with any framework (Next.js, Nuxt, SvelteKit, Remix, Astro, Hono, Express, etc.)</trigger> </triggers>

Quick Start

Installation

<example type="usage"> <code language="bash"> npm install better-auth # or pnpm/yarn/bun add better-auth </code> </example>

Environment Setup

Create .env:

BETTER_AUTH_SECRET=<generated-secret-32-chars-min>
BETTER_AUTH_URL=http://localhost:3000

Basic Server Setup

Create auth.ts (root, lib/, utils/, or under src/app/server/):

<example type="usage"> <code language="typescript"> import { betterAuth } from "better-auth";

export const auth = betterAuth({ database: { // See references/database-integration.md }, emailAndPassword: { enabled: true, autoSignIn: true }, socialProviders: { github: { clientId: process.env.GITHUB_CLIENT_ID!, clientSecret: process.env.GITHUB_CLIENT_SECRET!, } } }); </code> </example>

Database Schema

<example type="usage"> <code language="bash"> npx @better-auth/cli generate # Generate schema/migrations npx @better-auth/cli migrate # Apply migrations (Kysely only) </code> </example>

Mount API Handler

Next.js App Router:

<example type="usage"> <code language="typescript"> // app/api/auth/[...all]/route.ts import { auth } from "@/lib/auth"; import { toNextJsHandler } from "better-auth/next-js";

export const { POST, GET } = toNextJsHandler(auth); </code> </example>

Other frameworks: See references/email-password-auth.md#framework-setup

Client Setup

Create auth-client.ts:

<example type="usage"> <code language="typescript"> import { createAuthClient } from "better-auth/client";

export const authClient = createAuthClient({ baseURL: process.env.NEXT_PUBLIC_BETTER_AUTH_URL || "http://localhost:3000" }); </code> </example>

Basic Usage

<example type="usage"> <code language="typescript"> // Sign up await authClient.signUp.email({ email: "user@example.com", password: "secure123", name: "John Doe" });

// Sign in await authClient.signIn.email({ email: "user@example.com", password: "secure123" });

// OAuth await authClient.signIn.social({ provider: "github" });

// Session const { data: session } = authClient.useSession(); // React/Vue/Svelte const { data: session } = await authClient.getSession(); // Vanilla JS </code> </example>

Feature Selection Matrix

FeaturePlugin RequiredUse CaseReference
Email/PasswordNo (built-in)Basic authemail-password-auth.md
OAuth (GitHub, Google, etc.)No (built-in)Social loginoauth-providers.md
Email VerificationNo (built-in)Verify email addressesemail-password-auth.md
Password ResetNo (built-in)Forgot password flowemail-password-auth.md
Two-Factor Auth (2FA/TOTP)Yes (twoFactor)Enhanced securityadvanced-features.md
Passkeys/WebAuthnYes (passkey)Passwordless authadvanced-features.md
Magic LinkYes (magicLink)Email-based loginadvanced-features.md
Username AuthYes (username)Username loginemail-password-auth.md
Organizations/Multi-tenantYes (organization)Team/org featuresadvanced-features.md
Rate LimitingNo (built-in)Prevent abuseadvanced-features.md
Session ManagementNo (built-in)User sessionsadvanced-features.md

Auth Method Selection Guide

Choose Email/Password when:

  • Building standard web app with traditional auth
  • Need full control over user credentials
  • Targeting users who prefer email-based accounts

Choose OAuth when:

  • Want quick signup with minimal friction
  • Users already have social accounts
  • Need access to social profile data

Choose Passkeys when:

  • Want passwordless experience
  • Targeting modern browsers/devices
  • Security is top priority

Choose Magic Link when:

  • Want passwordless without WebAuthn complexity
  • Targeting email-first users
  • Need temporary access links

Combine Multiple Methods when:

  • Want flexibility for different user preferences
  • Building enterprise apps with various auth requirements
  • Need progressive enhancement (start simple, add more options)

Core Architecture

Better Auth uses client-server architecture:

  1. Server (better-auth): Handles auth logic, database ops, API routes
  2. Client (better-auth/client): Provides hooks/methods for frontend
  3. Plugins: Extend both server/client functionality

Implementation Checklist

  • Install better-auth package
  • Set environment variables (SECRET, URL)
  • Create auth server instance with database config
  • Run schema migration (npx @better-auth/cli generate)
  • Mount API handler in framework
  • Create client instance
  • Implement sign-up/sign-in UI
  • Add session management to components
  • Set up protected routes/middleware
  • Add plugins as needed (regenerate schema after)
  • Test complete auth flow
  • Configure email sending (verification/reset)
  • Enable rate limiting for production
  • Set up error handling
<constraints> <constraint severity="critical">BETTER_AUTH_SECRET must be at least 32 characters and kept secure</constraint> <constraint severity="critical">Never expose BETTER_AUTH_SECRET in client-side code</constraint> <constraint severity="high">Always enable rate limiting in production to prevent brute force attacks</constraint> <constraint severity="high">Regenerate database schema after adding/removing plugins</constraint> <constraint severity="medium">Use HTTPS in production for all auth endpoints</constraint> <constraint severity="medium">Implement email verification for email/password auth in production</constraint> </constraints>

Reference Documentation

Core Authentication

Advanced Features

  • Advanced Features - 2FA/MFA, passkeys, magic links, organizations, rate limiting, session management

Scripts

  • scripts/better_auth_init.py - Initialize Better Auth configuration with interactive setup

Resources

Source

git clone https://github.com/zircote/agents/blob/main/skills/better-auth/SKILL.mdView on GitHub

Overview

Better Auth is a framework-agnostic TypeScript authentication and authorization framework. It includes built-in email/password with verification, OAuth providers, 2FA, passkeys/WebAuthn, session management, and RBAC, plus database adapters to fit any stack. Use it to add robust, scalable authentication to web apps.

How This Skill Works

Initialize Better Auth with a config object that wires your database adapter and enables features like email/password, social providers, and 2FA. It exposes framework-agnostic handlers you mount into your app (e.g., route handlers for sign-in/out, OAuth redirects, and session state). It also handles RBAC, rate limiting, and migrations via its CLI and adapters.

When to Use It

  • When adding authentication to a TypeScript/JavaScript application
  • When implementing OAuth login flows with providers (Google, GitHub, Discord, etc.)
  • When setting up 2FA/MFA (TOTP, SMS) and passkeys/WebAuthn
  • When managing user sessions and lifecycle across frameworks
  • When configuring authorization rules with RBAC or multi-tenant organization support

Quick Start

  1. Step 1: npm install better-auth
  2. Step 2: Create .env with BETTER_AUTH_SECRET and BETTER_AUTH_URL and add a basic server setup using betterAuth({ ... })
  3. Step 3: Generate the database schema and run migrations, then mount the API handler in your framework

Best Practices

  • Plan and map your RBAC roles and permissions before implementing
  • Use email verification for new accounts and consider autoSignIn when appropriate
  • Securely manage secrets (env vars) and rotate keys regularly
  • Enable rate limiting on authentication endpoints to deter abuse
  • Use the CLI to generate and migrate your database schema consistently

Example Use Cases

  • Sign-up and sign-in with email/password including verification in a Next.js app
  • GitHub or Google OAuth sign-in for a SaaS dashboard
  • Enforce TOTP-based 2FA for sensitive actions
  • Passwordless login using passkeys/WebAuthn
  • RBAC-enabled admin area in a multi-tenant org-based app

Frequently Asked Questions

Add this skill to your agents
Sponsor this space

Reach thousands of developers