Getting Started

Get up and running with Lizard in minutes.

Prerequisites

Node.js version 20.0 or above
npm or yarn
A Lizard account — sign up at lizard.build

Installation

Install the Lizard CLI globally:

npm install -g lizard

Or add it as a dev dependency:

npm install --save-dev lizard

Authentication

lizard login

This opens your browser for OAuth authentication. Once complete, your CLI is linked to your account.

Quick Start

Create a new project and start developing:

npx lizard init my-project
cd my-project
npm run dev

Your app is now running at http://localhost:3000 with hot reload enabled.

Project Structure

After lizard init, your project looks like this:

my-project/
├── lizard.config.ts    # Lizard configuration
├── src/
│   ├── index.ts        # Entry point
│   └── routes/         # API routes
├── package.json
└── .env.local          # Local environment variables

Next Steps

Configuration — customize your project settings
Deployment — ship to production
Environment Variables — manage secrets and config

Introduction Configuration