varitykit init

Varity Team Core Contributors Updated March 2026

Create a new Varity project from a starter template.

Usage

varitykit init [PROJECT_NAME] [OPTIONS]

Quick Start

# Interactive mode
varitykit init

# With project name
varitykit init my-app

# With template
varitykit init my-app --template saas-starter

Available Templates

Template	Description	Best For
`saas-starter`	SaaS dashboard with auth, analytics, and billing	Most applications

Options

Option	Short	Default	Description
`--template`	`-t`	`saas-starter`	Template to use
`--path`	`-p`	`.`	Path where project should be created
`--yes`	`-y`	`false`	Skip confirmation prompts
`--github`		`false`	Add GitHub Actions workflow for deployment

Interactive Mode

Running without arguments starts interactive mode:

$ varitykit init

? Project name: my-app
? Select a template: saas-starter

Creating project...
✓ Created project directory
✓ Copied template files
✓ Installed dependencies

Your project is ready!

Next steps:
  cd my-app
  npm run dev

Project Structure

The generated project includes:

my-app/
├── .env.local.example    # Environment variables template
├── .gitignore
├── package.json
├── tsconfig.json
├── next.config.mjs
├── src/
│   ├── app/
│   │   ├── layout.tsx    # Root layout with auth provider
│   │   ├── page.tsx      # Home page
│   │   └── dashboard/
│   │       └── page.tsx  # Protected dashboard
│   ├── components/
│   │   ├── Header.tsx
│   │   └── LoginButton.tsx
│   └── lib/
│       └── varity.ts     # Varity SDK setup
└── public/
    └── logo.svg

What’s Included

The SaaS starter template includes:

Authentication - Auth provider pre-configured
Protected Routes - Route protection examples
Dashboard Layout - Responsive sidebar and navigation
Analytics - Data tables, charts, and KPIs
Environment Variables - .env.local.example with all variables
TypeScript - Full type support
Styling - Tailwind CSS configured
Deployment Ready - Works with varitykit app deploy

Environment Setup

After initialization, set up your environment:

Copy the example environment file
Terminal window
```
cp .env.local.example .env.local
```
Start development server
Terminal window
```
npm run dev
```

Custom Templates

Create your own template:

# Save current project as template
varitykit template save my-template

# Use custom template
varitykit init new-project --template my-template

# List available templates
varitykit template list

Troubleshooting

”Template not found”

List available templates:

varitykit template list

“npm install failed”

Try installing dependencies manually:

cd my-app
npm install

Next Steps

CLI Overview - All CLI commands
Quick Start Guide - Complete tutorial
Package Installation - SDK setup