Better Auth

https://github.com/better-auth/better-auth
Admin
Better Auth is a framework-agnostic authentication and authorization library for TypeScript,...
Tokens:817,494
Snippets:5,453
Trust Score:7.6
License:MIT
Update:3 hours ago
Show doc for...
Tokens:
Raw
### Install dependencies and start development server

Source: https://github.com/better-auth/better-auth/blob/main/docs/README.md

Install dependencies and run the development server locally to preview the documentation website at localhost:3000.

```bash
# install
pnpm install

# develop
pnpm dev
```

--------------------------------

### Install dependencies and start development server

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/examples/astro.mdx

Install project dependencies and run the local Astro development server.

```bash
pnpm install
pnpm run dev
```

--------------------------------

### Install dependencies and start development server

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/examples/react-router.mdx

Run these commands after cloning the repository and configuring environment variables from .env.example.

```bash
pnpm install
pnpm run dev
```

--------------------------------

### Install dependencies and start development server

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/examples/next-js.mdx

Run these commands in the cloned Next.js project directory after configuring the .env file to install required packages and launch the local development server at http://localhost:3000.

```bash
pnpm install
pnpm dev
```

--------------------------------

### Install dependencies and start development server

Source: https://github.com/better-auth/better-auth/blob/main/demo/electron/README.md

Run these commands in the cloned repository to install required packages and launch the Electron application in development mode.

```bash
pnpm install
pnpm dev
```

--------------------------------

### Install dependencies and start the Expo development server

Source: https://github.com/better-auth/better-auth/blob/main/demo/expo/README.md

Run these commands after cloning the repository and configuring environment variables to install project dependencies and launch Expo.

```bash
pnpm install
pnpm start
```

--------------------------------

### Install better-auth package

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/installation.mdx

Installs the Better Auth package. If using a separate client and server setup, install Better Auth in both parts of the project.

```shell
better-auth
```

--------------------------------

### Install @chargebee/better-auth plugin

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/plugins/chargebee.mdx

Install the @chargebee/better-auth package. If using separate client and server setups, ensure it is installed in both parts.

```package-install
@chargebee/better-auth
```

--------------------------------

### Install Chargebee SDK

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/plugins/chargebee.mdx

Install the official Chargebee SDK on your server.

```package-install
chargebee
```

--------------------------------

### Install @better-auth/redis-storage and ioredis

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/concepts/database.mdx

Install the official Redis storage package and ioredis.

```bash
@better-auth/redis-storage ioredis
```

--------------------------------

### Install @prisma/client

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/integrations/nitro.mdx

Installs the Prisma client library for database communication.

```package-install
@prisma/client
```

--------------------------------

### Install Stripe SDK

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/plugins/stripe.mdx

Install the Stripe SDK dependency on your server.

```package-install
stripe@^22.0.0
```

--------------------------------

### Install @upstash/redis

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/concepts/database.mdx

Install the Upstash Redis client.

```bash
@upstash/redis
```

--------------------------------

### Install @creem_io/better-auth package

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/plugins/creem.mdx

Install the Creem plugin. Requires better-auth 1.5.6 or later and should be installed in both client and server setups if separated.

```package-install
@creem_io/better-auth
```

--------------------------------

### Install @better-auth/stripe plugin

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/plugins/stripe.mdx

Install the Better Auth Stripe plugin package. If using separate client and server setups, install it across both environments.

```package-install
@better-auth/stripe
```

--------------------------------

### Install the Dub SDK package

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/plugins/dub.mdx

Install the official Dub SDK package on your server.

```package-install
dub
```

--------------------------------

### Install @better-auth/prisma-adapter using npm

Source: https://github.com/better-auth/better-auth/blob/main/packages/prisma-adapter/README.md

Install the Prisma adapter package for Better Auth into your project.

```bash
npm install @better-auth/prisma-adapter

```

--------------------------------

### Install Encore CLI and initialize project

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/integrations/encore.mdx

Scaffold a new TypeScript Encore application and install the Better Auth dependency.

```bash
brew install encoredev/tap/encore # if you don't have Encore installed
encore app create my-app --example=ts/hello-world
cd my-app
npm install better-auth
```

--------------------------------

### Install @better-auth/sso plugin

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/plugins/sso.mdx

Install the SSO plugin package using the package manager command shown in the installation step.

```package-install
@better-auth/sso
```

--------------------------------

### Install project dependencies with pnpm

Source: https://github.com/better-auth/better-auth/blob/main/CONTRIBUTING.md

Install all required packages and dependencies for the repository.

```bash
pnpm install
```

--------------------------------

### Create TanStack Start project with Better Auth CLI

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/integrations/tanstack.mdx

Initialize a new TanStack Start project and select Better Auth from the add-ons prompt to configure an instance with mounted handlers.

```package-install
npm create @tanstack/start

◇  What add-ons would you like for your project?
│  Better Auth
```

--------------------------------

### Install @better-auth/oauth-provider

Source: https://github.com/better-auth/better-auth/blob/main/packages/oauth-provider/README.md

Install the OAuth provider plugin package using npm.

```bash
npm install @better-auth/oauth-provider
```

--------------------------------

### Set up Node.js version using nvm

Source: https://github.com/better-auth/better-auth/blob/main/CONTRIBUTING.md

Install and switch to the project's configured Node.js version using nvm.

```bash
nvm install
nvm use
```

--------------------------------

### Install node-redis

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/concepts/database.mdx

Install the node-redis client for Redis 7 or later.

```bash
redis
```

--------------------------------

### Install @better-auth/i18n

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/plugins/i18n.mdx

Install the internationalization plugin package for Better Auth.

```package-install
@better-auth/i18n
```

--------------------------------

### Install @better-auth/api-key package

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/blogs/1-5.mdx

Install the standalone API key plugin package.

```package-install
npm install @better-auth/api-key
```

--------------------------------

### Install Better Auth Passkey Plugin

Source: https://github.com/better-auth/better-auth/blob/main/packages/passkey/README.md

Install better-auth and @better-auth/passkey using npm, yarn, pnpm, or bun.

```bash
# Using npm
npm install better-auth @better-auth/passkey

# Using yarn
yarn add better-auth @better-auth/passkey

# Using pnpm
pnpm add better-auth @better-auth/passkey

# Using bun
bun add better-auth @better-auth/passkey
```

--------------------------------

### Install PostgreSQL client package

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/guides/auth0-migration-guide.mdx

Install the pg package to connect Better Auth to a PostgreSQL database instance.

```package-install
npm install pg
```

--------------------------------

### Install @better-auth/kysely-adapter

Source: https://github.com/better-auth/better-auth/blob/main/packages/kysely-adapter/README.md

Installs the Kysely adapter package for Better Auth using npm.

```bash
npm install @better-auth/kysely-adapter
```

--------------------------------

### Install @effect/platform-node

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/integrations/effect.mdx

Install the Node.js platform adapter for Effect HTTP server.

```package-install
@effect/platform-node
```

--------------------------------

### Install @better-auth/drizzle-adapter

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/adapters/drizzle.mdx

Install the Drizzle adapter package to use Relations v2.

```bash
npm install @better-auth/drizzle-adapter
```

--------------------------------

### Start Next.js development server

Source: https://github.com/better-auth/better-auth/blob/main/demo/nextjs/README.md

Launch the local development server on http://localhost:3000 using npm, yarn, pnpm, or bun.

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
```

--------------------------------

### Run Documentation Locally with pnpm

Source: https://github.com/better-auth/better-auth/blob/main/CONTRIBUTING.md

Starts the local development server for the documentation site located under docs/.

```bash
pnpm -F docs dev
```

--------------------------------

### Install @better-auth/test-utils

Source: https://github.com/better-auth/better-auth/blob/main/packages/test-utils/README.md

Install the @better-auth/test-utils package using npm for adapter development and integration testing.

```bash
npm install @better-auth/test-utils
```

--------------------------------

### Install pg and Connect Database in auth.ts

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/guides/supabase-migration-guide.mdx

Install the pg package and initialize Better Auth with a PostgreSQL connection pool using DATABASE_URL from Supabase.

```package-install
npm install pg
```

```typescript
import { betterAuth } from 'better-auth';
import { Pool } from "pg";

export const auth = betterAuth({
    database: new Pool({ 
        connectionString: process.env.DATABASE_URL 
    }),
})
```

--------------------------------

### Install @better-auth/scim package

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/plugins/scim/index.mdx

Install the SCIM plugin package into your application.

```package-install
@better-auth/scim
```

--------------------------------

### Install Better Auth Prisma adapter

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/adapters/prisma.mdx

Install the @better-auth/prisma-adapter package into your project dependencies.

```package-install
@better-auth/prisma-adapter
```

--------------------------------

### Install @better-auth/i18n package

Source: https://github.com/better-auth/better-auth/blob/main/packages/i18n/README.md

Install the internationalization plugin package via npm.

```bash
npm install @better-auth/i18n
```

--------------------------------

### Install Effect

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/integrations/effect.mdx

Install the core Effect package in your project.

```package-install
effect
```

--------------------------------

### Install @better-auth/api-key package

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/plugins/api-key/index.mdx

Install the API Key plugin package dependency.

```package-install
@better-auth/api-key
```

--------------------------------

### Install @better-auth/mongo-adapter via npm

Source: https://github.com/better-auth/better-auth/blob/main/packages/mongo-adapter/README.md

Run this command to install the MongoDB adapter package for Better Auth into your project.

```bash
npm install @better-auth/mongo-adapter
```

--------------------------------

### Install Better Auth and Expo plugin

Source: https://github.com/better-auth/better-auth/blob/main/packages/expo/README.md

Install the core `better-auth` and `@better-auth/expo` packages using npm, yarn, pnpm, or bun.

```bash
# Using npm
npm install better-auth @better-auth/expo

# Using yarn
yarn add better-auth @better-auth/expo

# Using pnpm
pnpm add better-auth @better-auth/expo

# Using bun
bun add better-auth @better-auth/expo
```

--------------------------------

### Install better-auth package

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/concepts/client.mdx

Install the core better-auth package using npm.

```package-install
npm i better-auth
```

--------------------------------

### Install Commet and Better Auth packages

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/plugins/commet.mdx

Install the necessary dependencies including Better Auth and the Commet client packages.

```package-install
better-auth @commet/better-auth @commet/node
```

--------------------------------

### Mount Better Auth handler in TanStack Start

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/installation.mdx

Defines GET and POST server handlers for the catch-all auth route using TanStack Router.

```typescript
import { auth } from '@/lib/auth'
import { createFileRoute } from '@tanstack/react-router'

export const Route = createFileRoute('/api/auth/$')({
    server: {
        handlers: {
            GET: async ({ request }:{ request: Request }) => {
                return await auth.handler(request)
            },
            POST: async ({ request }:{ request: Request }) => {
                return await auth.handler(request)
            },
        },
    },
})
```

--------------------------------

### Install project dependencies

Source: https://github.com/better-auth/better-auth/blob/main/demo/nextjs/README.md

Install required dependencies using npm, yarn, or pnpm.

```bash
npm install
# or
yarn install
# or
pnpm install
```

--------------------------------

### Install @better-auth/infra package

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/infrastructure/getting-started.mdx

Install the Better Auth Infrastructure package to access infrastructure plugins and client utilities.

```package-install
@better-auth/infra
```

--------------------------------

### Install @better-auth/core with npm

Source: https://github.com/better-auth/better-auth/blob/main/packages/core/README.md

Install the Better Auth core utilities and types package as a dependency.

```bash
npm install @better-auth/core
```

--------------------------------

### Install pg and configure database connection in auth.ts

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/guides/clerk-migration-guide.mdx

Install the PostgreSQL client library and initialize Better Auth with a connection pool. Replace the database connection string with your PostgreSQL environment variable.

```package-install
npm install pg
```

```typescript
import { Pool } from "pg";

export const auth = betterAuth({
    database: new Pool({ 
        connectionString: process.env.DATABASE_URL 
    }),
})
```

--------------------------------

### Initialize Prisma with PostgreSQL provider

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/adapters/prisma.mdx

Initialize a new Prisma setup configured for PostgreSQL and specify an explicit Prisma Client output location.

```package-install
npx prisma init --datasource-provider postgresql --output ../src/generated/prisma
```

--------------------------------

### Install the Dub Better Auth plugin package

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/plugins/dub.mdx

Install the @dub/better-auth package to add Dub lead tracking and OAuth linking to Better Auth.

```package-install
@dub/better-auth
```

--------------------------------

### Install Better Auth and Convex dependencies

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/integrations/convex.mdx

Install the required Better Auth and Convex Better Auth packages.

```shell
npm install better-auth @convex-dev/better-auth
```

--------------------------------

### Install @better-auth/mcp and companion packages

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/plugins/mcp.mdx

Install the MCP plugin, the recommended CIMD companion package, the official MCP TypeScript SDK v2, and zod.

```package-install
@better-auth/mcp @better-auth/cimd @modelcontextprotocol/server zod
```

--------------------------------

### Install @better-auth/passkey package

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/plugins/passkey.mdx

Installs the passkey plugin package into your project dependencies.

```package-install
npm install @better-auth/passkey
```

--------------------------------

### Install @better-auth/stripe via npm

Source: https://github.com/better-auth/better-auth/blob/main/packages/stripe/README.md

Install the Stripe integration plugin package for Better Auth.

```bash
npm install @better-auth/stripe
```

--------------------------------

### Install Better Auth 1.3

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/blogs/1-3.mdx

Run this command to upgrade or install Better Auth version 1.3.

```shell
npm install better-auth@1.3
```

--------------------------------

### Install MongoDB adapter package

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/adapters/mongo.mdx

Install the `@better-auth/mongo-adapter` package to use MongoDB with Better Auth.

```package-install
@better-auth/mongo-adapter
```

--------------------------------

### Install @better-auth/memory-adapter via npm

Source: https://github.com/better-auth/better-auth/blob/main/packages/memory-adapter/README.md

Install the in-memory adapter dependency using npm for development and testing.

```bash
npm install @better-auth/memory-adapter
```

--------------------------------

### Install @better-auth/test-utils via npm

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/guides/create-a-db-adapter.mdx

Install the required test utilities development dependency before testing your adapter with Vitest.

```bash
npm install -D @better-auth/test-utils
```

--------------------------------

### Install @better-auth/cimd

Source: https://github.com/better-auth/better-auth/blob/main/packages/cimd/README.md

Install the Better Auth CIMD plugin package using npm.

```bash
npm install @better-auth/cimd
```

--------------------------------

### Start local development server

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/integrations/encore.mdx

Runs the Encore application locally. Requires Docker to be running to manage local infrastructure.

```bash
encore run
```

--------------------------------

### Install @better-auth/scim via pnpm

Source: https://github.com/better-auth/better-auth/blob/main/packages/scim/README.md

Installs the SCIM plugin package into your project using pnpm.

```bash
pnpm add @better-auth/scim
```

--------------------------------

### Interactive MCP Setup via CLI

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/ai-resources/mcp.mdx

Run the Better Auth CLI without flags to view and select from supported MCP client targets.

```bash
npx auth@latest mcp
```

--------------------------------

### Set up environment variables

Source: https://github.com/better-auth/better-auth/blob/main/demo/nextjs/README.md

Rename `.env.example` to `.env` to configure required database credentials and Better Auth service secrets.

```bash
mv .env.example .env
```

--------------------------------

### Install Better Auth skills using npx skills add

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/ai-resources/skills.mdx

Installs the Better Auth skill pack into your project using the skills CLI. Restart the coding agent or reload skills after installation if your editor requires it.

```bash
npx skills add better-auth/skills
```

--------------------------------

### Install Dodo Payments dependencies

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/plugins/dodopayments.mdx

Run this npm command in your project root to install Better Auth, Dodo Payments adapter, and required peer dependencies.

```bash
npm install @dodopayments/better-auth dodopayments better-auth zod
```

--------------------------------

### Install pnpm globally with npm

Source: https://github.com/better-auth/better-auth/blob/main/CONTRIBUTING.md

Alternative installation method for pnpm when not using corepack.

```bash
npm install -g pnpm
```

--------------------------------

### Install Better Auth and Electron integration packages

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/integrations/electron.mdx

Run in your server, Electron app, and web client projects to install the required Better Auth dependencies.

```package-install
better-auth @better-auth/electron
```

--------------------------------

### Install Better Auth and Lynx React dependencies

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/integrations/lynx.mdx

Install the required packages for Lynx integration with Better Auth.

```shell
better-auth @lynx-js/react
```

--------------------------------

### GET /dash/user/2fa/totp-uri

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/infrastructure/plugins/dashboard.mdx

Retrieve the TOTP URI for two-factor authentication setup.

```APIDOC
## GET /dash/user/2fa/totp-uri

### Description
Get TOTP URI.

### Method
GET

### Endpoint
`/dash/user/2fa/totp-uri`
```

--------------------------------

### Basic Stateless Setup with betterAuth

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/concepts/session-management.mdx

Use this when you want stateless sessions without a database. Better Auth automatically enables stateless mode when no database configuration is provided.

```ts
import { betterAuth } from "better-auth"

export const auth = betterAuth({
    // No database configuration
    socialProviders: {
        google: {
            clientId: process.env.GOOGLE_CLIENT_ID,
            clientSecret: process.env.GOOGLE_CLIENT_SECRET,
        },
    },
});
```

--------------------------------

### Initialize Prisma configuration

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/integrations/nitro.mdx

Generates a starter schema.prisma file inside the prisma directory.

```bash
npx prisma init
```

--------------------------------

### Install @thallesp/nestjs-better-auth package

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/integrations/nestjs.mdx

Install the community-maintained Better Auth integration library for NestJS.

```package-install
@thallesp/nestjs-better-auth
```

--------------------------------

### Initialize Electron main process with authClient.setupMain

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/integrations/electron.mdx

Registers protocol handlers, image proxies, content security policies, and IPC bridges. Must be called before the app is ready.

```ts
import { authClient } from "./lib/auth-client";

authClient.setupMain();
```

--------------------------------

### Configure Auth.js instance with GitHub provider

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/guides/next-auth-migration-guide.mdx

Auth.js server configuration example using NextAuth and the GitHub OAuth provider.

```ts
import NextAuth from "next-auth"
import GitHub from "next-auth/providers/github"
  
export const { handlers, signIn, signOut, auth } = NextAuth({
  providers: [GitHub],
})
```

--------------------------------

### Get session in TanStack Start API route

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/basic-usage.mdx

Use this in a TanStack Start API route to retrieve the session. Import `auth` from your Better Auth server instance and `createAPIFileRoute` from `@tanstack/start/api`. Pass `request.headers` to `auth.api.getSession`.

```typescript
import { auth } from "./auth";
import { createAPIFileRoute } from "@tanstack/start/api";

export const APIRoute = createAPIFileRoute("/api/$")({
    GET: async ({ request }) => {
        const session = await auth.api.getSession({
            headers: request.headers
        })
    },
});
```

--------------------------------

### Install Better Auth 1.2.0

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/changelogs/1-2.mdx

Install or upgrade to the exact Better Auth release version 1.2.0.

```bash
npm install better-auth@1.2.0
```

--------------------------------

### Install @better-auth/cimd

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/plugins/cimd.mdx

Install the CIMD plugin package into your project using your package manager.

```package-install
@better-auth/cimd
```

--------------------------------

### Sign Up with Email and Password

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/basic-usage.mdx

Use the client method `signUp.email` to register a new user with email, password, name, and optional image and callback URL. The example includes callbacks for request, success, and error handling.

```ts
import { authClient } from "@/lib/auth-client"; //import the auth client // [!code highlight]

const { data, error } = await authClient.signUp.email({
        email, // user email address
        password, // user password -> min 8 characters by default
        name, // user display name
        image, // User image URL (optional)
        callbackURL: "/dashboard" // A URL to redirect to after the user verifies their email (optional)
    }, {
        onRequest: (ctx) => {
            //show loading
        },
        onSuccess: (ctx) => {
            //redirect to the dashboard or sign in page
        },
        onError: (ctx) => {
            // display the error message
            alert(ctx.error.message);
        },
});
```

--------------------------------

### Defer session refresh in auth.ts

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/concepts/session-management.mdx

Use this to make GET /get-session read-only, avoiding database writes that can cause issues with read-replica setups. When enabled, GET returns needsRefresh: true when refresh is needed, and the client automatically calls POST to perform the refresh.

```ts
import { betterAuth } from "better-auth"

export const auth = betterAuth({
    session: {
        deferSessionRefresh: true
    }
})
```

--------------------------------

### Install Fastify Dependencies

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/integrations/fastify.mdx

Installs Fastify and the official CORS plugin required for the integration.

```package-install
fastify @fastify/cors
```

--------------------------------

### List API keys usage examples

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/plugins/api-key/index.mdx

Demonstrates pagination, sorting, and filtering by organization or configuration using authClient.apiKey.list.

```typescript
// Get first 10 API keys for the current user
const result = await authClient.apiKey.list({
  query: { limit: 10 }
});

// Get second page (10 items per page)
const page2 = await authClient.apiKey.list({
  query: { limit: 10, offset: 10 }
});

// Sort by creation date (newest first)
const sorted = await authClient.apiKey.list({
  query: { sortBy: "createdAt", sortDirection: "desc" }
});

// Combined pagination and sorting
const combined = await authClient.apiKey.list({
  query: { 
    limit: 20, 
    offset: 0, 
    sortBy: "name", 
    sortDirection: "asc" 
  }
});

// List organization-owned keys
const orgKeys = await authClient.apiKey.list({
  query: { organizationId: "org_123" }
});

// List organization keys with specific config
const orgPublicKeys = await authClient.apiKey.list({
  query: { 
    organizationId: "org_123",
    configId: "public" 
  }
});
```

--------------------------------

### Install and configure Stripe Plugin in auth.ts

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/changelogs/1-2.mdx

Install the Stripe plugin package and configure customer creation on signup and subscription plans in auth.ts.

```bash
npm install @better-auth/stripe
```

```typescript
import { stripe } from "@better-auth/stripe"; // [!code highlight]

export const auth = betterAuth({
  plugins: [
    stripe({
      // [!code highlight]
      createCustomerOnSignup: true, // [!code highlight]
      subscription: { // [!code highlight]
        enabled: true, // [!code highlight]
        plans: [// [!code highlight]
          { // [!code highlight]
            name: "pro", // [!code highlight]
            priceId: "price_1234567890", // [!code highlight]
          }, // [!code highlight]
        ], // [!code highlight]
      }, // [!code highlight]
    }), // [!code highlight]
  ],
});
```

--------------------------------

### Install conf package for default storage

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/integrations/electron.mdx

Install the conf package to use the pre-built default storage adapter for the Electron client.

```package-install
conf
```

--------------------------------

### Install @better-auth/telemetry via npm

Source: https://github.com/better-auth/better-auth/blob/main/packages/telemetry/README.md

Installs the anonymous usage telemetry package for Better Auth via npm.

```bash
npm install @better-auth/telemetry
```

--------------------------------

### Sign in with Vercel using signIn.social

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/authentication/vercel.mdx

Use the client's signIn.social function with provider set to "vercel" to start the Vercel sign-in flow.

```typescript
import { createAuthClient } from "better-auth/client"
const authClient = createAuthClient()

const signIn = async () => {
    const data = await authClient.signIn.social({
        provider: "vercel"
    })
}
```

--------------------------------

### Install Polar Better Auth packages with pnpm

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/plugins/polar.mdx

Install the required packages for integrating Polar with Better Auth.

```bash
pnpm add better-auth @polar-sh/better-auth @polar-sh/sdk
```

--------------------------------

### Initialize Better Auth with CLI

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/changelogs/1-2.mdx

Run the CLI init command to scaffold new projects, generate schemas, and execute migrations.

```bash
npx auth init
```

--------------------------------

### Install expo-secure-store

Source: https://github.com/better-auth/better-auth/blob/main/packages/expo/README.md

Install `expo-secure-store` for secure session and cookie storage across your Expo application.

```bash
npm install expo-secure-store
# or
yarn add expo-secure-store
# or
pnpm add expo-secure-store
# or
bun add expo-secure-store
```

--------------------------------

### Start database containers with docker compose

Source: https://github.com/better-auth/better-auth/blob/main/CONTRIBUTING.md

Start required Docker containers in the background before running database adapter tests. On macOS, MSSQL requires Rosetta emulation and at least 2 GB memory.

```bash
docker compose up -d
```

--------------------------------

### Test device authorization with the CLI

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/plugins/device-authorization.mdx

Runs the interactive demo device authorization flow against the Better Auth demo server.

```package-install
npx auth login
```

--------------------------------

### Sign In with Email and Password

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/basic-usage.mdx

Use the client method `signIn.email` to authenticate a user with email and password. The example includes optional `callbackURL` and `rememberMe` parameters, and a placeholder for callbacks.

```ts
const { data, error } = await authClient.signIn.email({
        /**
         * The user email
         */
        email,
        /**
         * The user password
         */
        password,
        /**
         * A URL to redirect to after the user verifies their email (optional)
         */
        callbackURL: "/dashboard",
        /**
         * remember the user session after the browser is closed. 
         * @default true
         */
        rememberMe: false
}, {
    //callbacks
})
```

--------------------------------

### Install @better-auth/sso via npm

Source: https://github.com/better-auth/better-auth/blob/main/packages/sso/README.md

Installs the Better Auth Single Sign-On plugin package for SAML and OIDC enterprise SSO support.

```bash
npm install @better-auth/sso
```

--------------------------------

### Info command options and export examples

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/concepts/cli.mdx

Demonstrates running the info command with a custom configuration path using --config or exporting redacted diagnostic data as JSON using --json.

```bash
# Basic usage
npx auth@latest info

# Custom config path
npx auth@latest info --config ./config/auth.ts

# JSON output
npx auth@latest info --json > auth-info.json
```

--------------------------------

### Install Vercel BotID SDK

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/plugins/captcha.mdx

Install the botid package when using Vercel BotID as your captcha provider.

```package-install
npm install botid
```

--------------------------------

### Clone repository and enter directory

Source: https://github.com/better-auth/better-auth/blob/main/CONTRIBUTING.md

Fork the repository and clone it to your local environment.

```bash
git clone https://github.com/your-username/better-auth.git
cd better-auth
```

--------------------------------

### Install Better Auth SSO package

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/guides/supabase-migration-guide.mdx

Install the @better-auth/sso package required for SAML SSO functionality.

```package-install
npm install @better-auth/sso
```

--------------------------------

### Install @better-auth/redis-storage via npm

Source: https://github.com/better-auth/better-auth/blob/main/packages/redis-storage/README.md

Install the Better Auth Redis storage package to enable Redis secondary storage for session caching and rate limiting.

```bash
npm install @better-auth/redis-storage
```

--------------------------------

### Install bcrypt dependency

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/guides/supabase-migration-guide.mdx

Installs the bcrypt library required to verify Supabase-hashed user passwords in Better Auth.

```package-install
npm install bcrypt
```

--------------------------------

### Install Better Auth 1.4

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/blogs/1-4.mdx

Upgrade or install Better Auth version 1.4 using npm.

```package-install
npm install better-auth@1.4
```

--------------------------------

### Install Better Auth Server Dependencies

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/integrations/expo.mdx

Installs the Better Auth core library and Expo plugin for your server application.

```package-install
better-auth @better-auth/expo
```

--------------------------------

### Install and configure bcrypt password hashing

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/guides/auth0-migration-guide.mdx

Install bcrypt and configure Better Auth to use bcrypt for password hashing and verification to support migrated Auth0 password hashes.

```bash
npm install bcrypt
npm install -D @types/bcrypt
```

```ts
import { betterAuth } from "better-auth";
import bcrypt from "bcrypt";

export const auth = betterAuth({
   emailAndPassword: {
       password: {
           hash: async (password) => {
               return await bcrypt.hash(password, 10);
           },
           verify: async ({ hash, password }) => {
               return await bcrypt.compare(password, hash);
           }
       }
   }
})
```

--------------------------------

### Install and configure the dash plugin

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/infrastructure/plugins/dashboard.mdx

Registers the dash plugin to connect your Better Auth instance to Better Auth Infrastructure.

```typescript
import { betterAuth } from "better-auth";
import { dash } from "@better-auth/infra";

export const auth = betterAuth({
  plugins: [
    dash(),
  ],
});
```

--------------------------------

### Create Solid auth client in lib/auth-client.ts

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/concepts/client.mdx

Initializes the Solid auth client using createAuthClient from better-auth/solid.

```ts
import { createAuthClient } from "better-auth/solid" // [!code highlight]
export const authClient = createAuthClient({
    baseURL: "http://localhost:3000" // The base URL of your auth server // [!code highlight]
})
```

--------------------------------

### Build the project

Source: https://github.com/better-auth/better-auth/blob/main/CONTRIBUTING.md

Compiles and builds all packages in the project.

```bash
pnpm build
```

--------------------------------

### Scaffold a new Nitro application

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/integrations/nitro.mdx

Initializes a new Nitro application directory and installs its default dependencies.

```bash
npx create-nitro-app
```

--------------------------------

### Create a Convex project

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/integrations/convex.mdx

Initialize a new Convex project. Select "none" when prompted for user authentication.

```shell
npm create convex@latest

# Choose user authentication:
# > none
```

--------------------------------

### Install bcrypt TypeScript types

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/guides/supabase-migration-guide.mdx

Installs type declarations for bcrypt as a development dependency.

```bash
npm install -D @types/bcrypt
```

--------------------------------

### Initialize Better Auth with init

Source: https://github.com/better-auth/better-auth/blob/main/packages/cli/README.md

Adds Better Auth to your project.

```bash
npx auth@latest init
```

--------------------------------

### Define client metadata document (https://client.example.com/client-metadata.json)

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/plugins/cimd.mdx

Example of a Draft-02 compliant client metadata JSON document specifying client_credentials and private_key_jwt authentication.

```json
{
  "client_id": "https://client.example.com/client-metadata.json",
  "grant_types": ["client_credentials"],
  "token_endpoint_auth_method": "private_key_jwt",
  "jwks_uri": "https://client.example.com/jwks.json"
}
```

--------------------------------

### Create User

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/plugins/scim/reference.mdx

Example SCIM core User creation payload containing externalId, userName, displayName, name structure, and primary work email.

```json
{
  "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
  "externalId": "directory-user-42",
  "userName": "Ada.Login@Example.com",
  "displayName": "Countess of Lovelace",
  "name": {
    "formatted": "Augusta Ada King, Countess of Lovelace",
    "givenName": "Augusta Ada",
    "familyName": "King"
  },
  "emails": [
    {
      "value": "ada.work@example.com",
      "type": "work",
      "primary": true
    }
  ],
  "active": true
}
```

--------------------------------

### Configure Better Auth instance with GitHub social provider

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/guides/next-auth-migration-guide.mdx

Better Auth server configuration example defining the GitHub OAuth provider in auth.ts.

```ts
import { betterAuth } from "better-auth";

export const auth = betterAuth({
  socialProviders: { 
    github: { 
      clientId: process.env.GITHUB_CLIENT_ID!, 
      clientSecret: process.env.GITHUB_CLIENT_SECRET!, 
    }, 
  }, 
})
```

--------------------------------

### Install expo-secure-store Package

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/integrations/expo.mdx

Installs expo-secure-store to securely persist session data and cookies on the client.

```package-install
expo-secure-store
```

--------------------------------

### Create Solid auth client

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/integrations/astro.mdx

Initializes the Solid auth client for Astro projects using Solid components.

```ts
import { createAuthClient } from "better-auth/solid"
export const authClient =  createAuthClient()
```

--------------------------------

### Configure sentinel plugin in server setup

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/infrastructure/getting-started.mdx

Add the sentinel plugin alongside dash for pro plans and above to enable security checks and abuse protection.

```ts
import { betterAuth } from "better-auth";
import { dash, sentinel } from "@better-auth/infra";  // [!code highlight]

export const auth = betterAuth({
  plugins: [
    dash({ /* ... */ }),
    sentinel({ // [!code highlight]
      apiKey: process.env.BETTER_AUTH_API_KEY, // [!code highlight]
    }) // [!code highlight]
  ],
});
```

--------------------------------

### Install expo-network Package

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/integrations/expo.mdx

Installs the expo-network package required for network state detection in Expo apps.

```package-install
expo-network
```

--------------------------------

### Configure Last Login Method Server and Client Plugins

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/plugins/last-login-method.mdx

Register the server plugin in auth config and client plugin in the auth client setup to enable tracking.

```ts
import { betterAuth } from "better-auth"
import { lastLoginMethod } from "better-auth/plugins" // [!code highlight]

export const auth = betterAuth({
    // ... other config options
    plugins: [
        lastLoginMethod() // [!code highlight]
    ]
})
```

```ts
import { createAuthClient } from "better-auth/client"
import { lastLoginMethodClient } from "better-auth/client/plugins" // [!code highlight]

export const authClient = createAuthClient({
    plugins: [
        lastLoginMethodClient() // [!code highlight]
    ]
})
```

--------------------------------

### Run Common CLI Commands

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/blogs/1-5.mdx

Execute database migrations, generate authentication schemas, or upgrade Better Auth using the standalone CLI.

```bash
npx auth migrate   # Run database migrations
npx auth generate  # Generate auth schema
npx auth upgrade   # Upgrade Better Auth to the latest version
```

--------------------------------

### Configure tanstackStartCookies plugin for Solid.js

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/installation.mdx

Enables automatic cookie handling for TanStack Start with Solid.js. Ensure tanstackStartCookies is the last plugin in the array.

```typescript
import { betterAuth } from "better-auth";
import { tanstackStartCookies } from "better-auth/tanstack-start/solid";

export const auth = betterAuth({
    //...your config
    plugins: [tanstackStartCookies()] // make sure this is the last plugin in the array
})
```

--------------------------------

### Mount Better Auth handler in SolidStart

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/installation.mdx

Exports GET and POST handlers using toSolidStartHandler in a catch-all API route.

```ts
import { auth } from "~/lib/auth"; // path to your auth file
import { toSolidStartHandler } from "better-auth/solid-start";

export const { GET, POST } = toSolidStartHandler(auth);
```

--------------------------------

### Initialize preload script with setupRenderer

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/integrations/electron.mdx

Exposes safe IPC bridges to the renderer process. Must be called before the app is ready.

```ts
import { setupRenderer } from "@better-auth/electron/preload";

setupRenderer();
```

--------------------------------

### Install Prisma CLI as a dev dependency

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/integrations/nitro.mdx

Installs the Prisma CLI development dependency for schema management and migrations.

```package-install
-D prisma
```

--------------------------------

### Generate Drizzle migration file

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/adapters/drizzle.mdx

Run this command to generate the migration file with Drizzle Kit.

```package-install
npx drizzle-kit generate # generate the migration file
```

--------------------------------

### Create auth instance in app/lib/auth.server.ts

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/integrations/react-router.mdx

Initialize Better Auth with your database configuration. Make sure to export the auth instance as a named export 'auth' or as a default export.

```ts
import { betterAuth } from "better-auth"

export const auth = betterAuth({
    database: {
        provider: "postgres", //change this to your database provider
        url: process.env.DATABASE_URL, // path to your database or connection string
    }
})
```

--------------------------------

### Configure OAuth Provider Dynamic Registration

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/plugins/oauth-provider.mdx

Example configuration for enabling dynamic client registration and setting the default application type to infer.

```ts
oauthProvider({
  allowDynamicClientRegistration: true,
  allowUnauthenticatedClientRegistration: true,
  clientRegistrationDefaultApplicationType: "infer",
  // ... other options
})
```

--------------------------------

### Configure selectAccount.page with shouldRedirect

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/plugins/oauth-provider.mdx

Enable account selection by setting selectAccount.page and shouldRedirect. This example uses the multi-session plugin and redirects to the select-account page when more than one session is logged in.

```ts
oauthProvider({
  selectAccount: {
    page: "/select-account", // [!code highlight]
    shouldRedirect: async ({ headers }) => { // [!code highlight]
      const allSessions = await auth.api.listDeviceSessions({
        headers,
      })
      return allSessions?.length >= 1;
    },
  }
})
```

--------------------------------

### Configure Dodo Payments client plugin in src/lib/auth-client.ts

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/plugins/dodopayments.mdx

Initialize the client-side Better Auth instance and attach the dodopaymentsClient plugin.

```typescript
import { createAuthClient } from "better-auth/react";
import { dodopaymentsClient } from "@dodopayments/better-auth";

export const authClient = createAuthClient({
  baseURL: process.env.BETTER_AUTH_URL || "http://localhost:3000",
  plugins: [dodopaymentsClient()],
});
```

--------------------------------

### Install identity dependencies for Expo

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/infrastructure/plugins/sentinel.mdx

Installs additional Expo packages to provide richer native identity payloads for Sentinel.

```package-install
expo-constants expo-device expo-crypto
```

--------------------------------

### Initialize Better Auth with init

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/concepts/cli.mdx

Initializes Better Auth in your project. Supports options for specifying application name, framework, plugins, database, and package manager.

```package-install
npx auth@latest init
```

--------------------------------

### Install multi-session plugin on server and client

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/plugins/multi-session.mdx

Add multiSession to the auth configuration on the server (auth.ts) and multiSessionClient to the client configuration (auth-client.ts) to enable managing multiple active sessions.

```typescript
import { betterAuth } from "better-auth"
import { multiSession } from "better-auth/plugins"  // [!code highlight]

export const auth = betterAuth({
    plugins: [
        multiSession(), // [!code highlight]
    ]
})
```

```typescript
import { createAuthClient } from "better-auth/client"
import { multiSessionClient } from "better-auth/client/plugins"  // [!code highlight]

export const authClient = createAuthClient({
    plugins: [
        multiSessionClient()  // [!code highlight]
    ]
})
```

--------------------------------

### Run info command for environment diagnostics

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/concepts/cli.mdx

Displays diagnostic information about the system, package manager, Better Auth version, frameworks, and database clients.

```package-install
npx auth@latest info
```

--------------------------------

### Configure Dodo Payments server-side plugin in src/lib/auth.ts

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/plugins/dodopayments.mdx

Initialize the DodoPayments client and register the dodopayments plugin with checkout products, customer portal, and webhook handlers. Set environment to live_mode in production.

```typescript
import { betterAuth } from "better-auth";
import {
  dodopayments,
  checkout,
  portal,
  webhooks,
} from "@dodopayments/better-auth";
import DodoPayments from "dodopayments";

export const dodoPayments = new DodoPayments({
  bearerToken: process.env.DODO_PAYMENTS_API_KEY!,
  environment: "test_mode"
});

export const auth = betterAuth({
  plugins: [
    dodopayments({
      client: dodoPayments,
      createCustomerOnSignUp: true,
      use: [
        checkout({
          products: [
            {
              productId: "pdt_xxxxxxxxxxxxxxxxxxxxx",
              slug: "premium-plan",
            },
          ],
          successUrl: "/dashboard/success",
          authenticatedUsersOnly: true,
        }),
        portal(),
        webhooks({
          webhookKey: process.env.DODO_PAYMENTS_WEBHOOK_SECRET!,
          onPayload: async (payload) => {
            console.log("Received webhook:", payload.event_type);
          },
        }),
      ],
    }),
  ],
});
```

--------------------------------

### Install Expo Social Authentication Dependencies

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/integrations/expo.mdx

Installs optional Expo dependencies needed when implementing social provider authentication flows.

```package-install
expo-linking expo-web-browser expo-constants

```

--------------------------------

### Execute project scripts with pnpm

Source: https://github.com/better-auth/better-auth/blob/main/docs/README.md

Commands for local development with Turbopack, building for production, serving production builds, and linting with Biome.

```bash
pnpm dev          # Start dev server (Turbopack)
pnpm build        # Production build
pnpm start        # Serve production build
pnpm lint:fix     # Lint & auto-fix with Biome
```

--------------------------------

### Create vanilla JavaScript auth client in lib/auth-client.ts

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/concepts/client.mdx

Initializes the framework-agnostic client instance with createAuthClient from better-auth/client.

```ts
import { createAuthClient } from "better-auth/client" // [!code highlight]
export const authClient = createAuthClient({
    baseURL: "http://localhost:3000" // The base URL of your auth server // [!code highlight]
})
```

--------------------------------

### Configure Passkey Client Plugin

Source: https://github.com/better-auth/better-auth/blob/main/packages/passkey/README.md

Initialize the Better Auth client with the passkeyClient plugin for client-side authentication handling.

```typescript
import { createAuthClient } from 'better-auth/client';
import { passkeyClient } from '@better-auth/passkey/client';

export const authClient = createAuthClient({
  plugins: [passkeyClient()],
});
```

--------------------------------

### Create an admin user with create-admin

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/concepts/cli.mdx

Creates an initial admin user through your configured Better Auth instance. Requires the Admin plugin and a persistent database, and asks for confirmation if users already exist unless bypassed.

```package-install
npx auth@latest create-admin --email admin@example.com --name "Admin" --role admin
```

--------------------------------

### Initialize Better Auth in server/utils/auth.ts

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/integrations/nitro.mdx

Configures the Better Auth instance using the Prisma adapter and enables email/password authentication.

```ts
import { betterAuth } from "better-auth";
import { prismaAdapter } from "better-auth/adapters/prisma";
import { PrismaClient } from "@prisma/client";

const prisma = new PrismaClient();

export default betterAuth({
  database: prismaAdapter(prisma, { provider: "sqlite" }),
  emailAndPassword: { enabled: true },
});
```

--------------------------------

### Run setup verification with check

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/concepts/cli.mdx

Runs all available checks to verify your Better Auth configuration manually or in automated pipelines. Accepts `--config` to define the configuration file path and `--cwd` to set the working directory.

```bash
npx auth@latest check --config ./src/auth.ts
```

--------------------------------

### Install Better Auth v1.7 Release Candidate

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/blogs/1-7-rc.mdx

Installs the release candidate version of Better Auth. The same rc tag should be applied to any additional @better-auth/* packages used in your project.

```package-install
better-auth@rc
```

--------------------------------

### Generate Prisma Client

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/adapters/prisma.mdx

Run the generate command to generate Prisma Client artifacts after configuring the output path.

```package-install
npx prisma generate
```

--------------------------------

### Sign private key JWT assertions with Vercel KMS in getClientAssertion

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/authentication/vercel.mdx

Use when the app runs on Vercel and you want KMS to sign assertions without storing a private key. Requires a KMS issuer, a project grant, the Vercel App JWKS URL set to the issuer's jwks.json, and @vercel/kms installed. Call signJWT inside getClientAssertion where a request context is available; iss and sub must be the OAuth client ID and ttl must be at most 60 seconds.

```ts
import { signJWT } from "@vercel/kms"
import { betterAuth } from "better-auth"

export const auth = betterAuth({
    socialProviders: {
        vercel: {
            clientId: process.env.VERCEL_CLIENT_ID as string,
            tokenEndpointAuth: {
                method: "private_key_jwt",
                async getClientAssertion({ clientId, tokenEndpoint }) {
                    const { token } = await signJWT({
                        issuerId: process.env.VERCEL_KMS_ISSUER_ID as string,
                        claims: {
                            iss: clientId,
                            sub: clientId,
                            aud: tokenEndpoint,
                            jti: crypto.randomUUID(),
                        },
                        ttl: 60,
                    })
                    return token
                },
            },
        },
    },
})
```

--------------------------------

### Run full test suite

Source: https://github.com/better-auth/better-auth/blob/main/CONTRIBUTING.md

Executes the complete test suite across the repository.

```bash
pnpm test
```

--------------------------------

### Filter Users with SCIM v2 GET Request

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/plugins/scim/reference.mdx

Send a GET request to filter the SCIM Users collection by the userName attribute. Requires Bearer token authentication in the Authorization header.

```http
GET /api/auth/scim/v2/Users?filter=userName%20eq%20%22ada.login%40example.com%22
Authorization: Bearer <token>
```

--------------------------------

### Install peer dependencies for React Native

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/infrastructure/plugins/sentinel.mdx

Installs the peer dependencies for Sentinel in React Native apps. Async Storage is optional; if omitted, the client uses a session-only in-memory visitor ID.

```package-install
@react-native-async-storage/async-storage react-native-get-random-values
```

--------------------------------

### Create migration and regenerate Prisma Client

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/adapters/prisma.mdx

Applies the schema changes by creating a database migration with Prisma and regenerating the Prisma Client.

```bash
npx prisma migrate dev --name add-better-auth
npx prisma generate
```

--------------------------------

### Apply Drizzle migration

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/adapters/drizzle.mdx

Run this command to apply the generated migration with Drizzle Kit.

```package-install
npx drizzle-kit migrate # apply the migration
```

--------------------------------

### Infer additional fields on client for monorepo setups in auth-client.ts

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/concepts/typescript.mdx

Uses inferAdditionalFields with typeof auth as a type parameter to automatically infer additional fields from your server configuration in monorepo or single-project setups.

```typescript
import { inferAdditionalFields } from "better-auth/client/plugins";
import { createAuthClient } from "better-auth/client";
import type { auth } from "@/lib/auth"; // Import the auth instance as a type

export const authClient = createAuthClient({
  plugins: [inferAdditionalFields<typeof auth>()],
});
```

--------------------------------

### Get invitation via GET /organization/get-invitation

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/plugins/organization.mdx

Retrieves invitation details using the invitation ID provided as a query parameter. Requires an active session and follows the same email-verification policy as accepting invitations by ID.

```ts
type getInvitation = {
    /**
     * The ID of the invitation to get.  
     */
    id: string = "invitation-id"
}
```

--------------------------------

### Example error response for too many attempts

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/plugins/phone-number.mdx

Example error response returned when a user exceeds the allowed number of OTP verification attempts. The response includes a 403 status and 'Too many attempts' message.

```json
{
  "error": {
    "status": 403,
    "message": "Too many attempts"
  }
}
```

--------------------------------

### Create a Hono App

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/integrations/hono.mdx

Use this command to create a new Hono application and select the template for your runtime or platform. Skip this step if you already have a Hono application.

```bash
npx create-hono@latest
```

--------------------------------

### Create Lynx Auth Client instance

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/integrations/lynx.mdx

Create and configure a client instance using createAuthClient from better-auth/lynx.

```typescript
import { createAuthClient } from "better-auth/lynx"

export const authClient = createAuthClient({
    baseURL: "http://localhost:3000" // The base URL of your auth server
})
```

--------------------------------

### GET /oauth2/get-consents

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/plugins/oauth-provider.mdx

Obtains a list of user consents.

```APIDOC
## GET /oauth2/get-consents

### Description
Obtains a list of user consents.

### Method
GET

### Endpoint
/oauth2/get-consents

### Request Example
GET /oauth2/get-consents

### Response
#### Success Response (200)
- **consents** (array) - List of consents

#### Response Example
{
  "consents": []
}
```

--------------------------------

### Configure Dodo Payments environment variables

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/plugins/dodopayments.mdx

Add the API key and webhook secret keys to your project's .env file.

```txt
DODO_PAYMENTS_API_KEY=your_api_key_here
DODO_PAYMENTS_WEBHOOK_SECRET=your_webhook_secret_here
```

--------------------------------

### GET /oauth2/get-consent

Source: https://github.com/better-auth/better-auth/blob/main/docs/content/docs/plugins/oauth-provider.mdx

Obtains details of a specific consent.

```APIDOC
## GET /oauth2/get-consent

### Description
Obtains details of a specific consent.

### Method
GET

### Endpoint
/oauth2/get-consent

### Query Parameters
- **id** (string) - Required - The consent id

### Request Example
GET /oauth2/get-consent?id=string

### Response
#### Success Response (200)
- **id** (string) - The consent id

#### Response Example
{
  "id": "string"
}
```

--------------------------------

### Set up test instance with getTestInstance

Source: https://github.com/better-auth/better-auth/blob/main/CONTRIBUTING.md

Use getTestInstance from better-auth/test to configure client and auth objects for unit testing.

```typescript
import { getTestInstance } from "better-auth/test";

const { client, auth } = await getTestInstance({
  plugins: [organization()],
});
```
Tokens:
Raw