Skip to main content
Better Auth Studio can be installed in multiple ways depending on your use case. Choose the method that best fits your workflow.

​
Installation methods

Install Better Auth Studio as a development dependency in your project. This ensures you’re using a project-specific version and keeps your production bundle clean. 
pnpm add -D better-auth-studio
Then run it using your package manager: 
pnpm better-auth-studio start
Add a script to your package.json for easier access:
package.json
{
  "scripts": {
    "studio": "better-auth-studio start",
    "studio:watch": "better-auth-studio start --watch"
  }
}
Then run: pnpm studio

​
Global installation

Install Better Auth Studio globally to use it across multiple projects: 
pnpm add -g better-auth-studio
Then run it from any directory: 
better-auth-studio start

​
One-time use with pnpx

Run Better Auth Studio without installing it using pnpx. This is perfect for trying it out or occasional use: 
pnpx better-auth-studio start
The first run will download the package, which may take a moment. Subsequent runs will be faster as the package is cached.

​
Production dependency (self-hosting)

If you’re self-hosting Studio in production, install it as a regular dependency: 
pnpm add better-auth-studio
For self-hosting, you must install as a regular dependency (not devDependency) since it’s required at runtime in production.
Learn more about self-hosting in the self-hosting guide.

​
Verify installation

Check that Better Auth Studio is installed correctly: 
pnpx better-auth-studio --version
This should output the current version (e.g., 1.1.3-beta.25).

​
Requirements

Before installing, ensure you meet these requirements:
  • Node.js: v18.0.0 or higher
  • Better Auth: A project with Better Auth configured
  • Database: One of the supported database adapters:
    • Prisma (PostgreSQL, MySQL, SQLite)
    • Drizzle (PostgreSQL, MySQL, SQLite)
    • better-sqlite3

​
Package details

Package name: better-auth-studio CLI command: better-auth-studio Current version: 1.1.3-beta.25 (beta) License: MIT

​
Updating

Keep Better Auth Studio up to date to get the latest features and bug fixes.

​
Update dev dependency

pnpm update better-auth-studio

​
Update global installation

pnpm add -g better-auth-studio@latest

​
Check for updates

View available versions: 
pnpm view better-auth-studio versions

​
Available commands

Once installed, you have access to these commands:

​
Start Studio

better-auth-studio start [options]
Starts the Studio development server. Options:
  • --port <number> - Specify port (default: 3000)
  • --host <string> - Specify host (default: localhost)
  • --no-open - Don’t automatically open browser
  • --config <path> - Path to auth config file
  • --watch - Watch for changes and auto-reload
Examples: 
# Start on port 3001
better-auth-studio start --port 3001

# Start with custom config file
better-auth-studio start --config ./src/lib/auth.ts

# Start with watch mode enabled
better-auth-studio start --watch

# Combine multiple options
better-auth-studio start --port 3001 --watch --no-open

​
Initialize self-hosting

better-auth-studio init
Creates a studio.config.ts file and route handler for self-hosting. Learn more in the self-hosting guide.

​
Show version

better-auth-studio --version
Displays the installed version.

​
Show help

better-auth-studio --help
Shows available commands and options.

​
Comparison of installation methods

MethodUse caseProsCons
Dev dependencyRegular development useProject-specific version, tracked in package.jsonRequires installation per project
GlobalUse across multiple projectsAvailable everywhere, single installationVersion management across projects
pnpxTrying it out, occasional useNo installation needed, always latestSlower first run, no version control
Production dependencySelf-hosting in productionDeployed with your appLarger bundle size

​
Troubleshooting

Make sure your global npm/pnpm bin directory is in your PATH:
# For pnpm
pnpm setup

# Check pnpm global bin location
pnpm bin -g
Add the output directory to your PATH if it’s not already there.
On Unix systems, you might need elevated permissions:
sudo pnpm add -g better-auth-studio
Or configure pnpm to use a user-level directory (recommended):
pnpm setup
Better Auth Studio requires Node.js v18 or higher. Check your version:
node --version
If needed, upgrade using nvm or download from nodejs.org.
Clear the pnpm cache and try again:
pnpm store prune
pnpx better-auth-studio start

​
Next steps

Quick start

Get Studio running in your project

Configuration

Learn how to configure your database adapter

Self-hosting

Deploy Studio with your application

CLI reference

Explore all available CLI commands and options

Build docs developers (and LLMs) love

Get started for freeTalk to us