Installation

Learn how to install Revali and its constructs

This guide will walk you through installing Revali and setting up your first project.

Prerequisites#

Dart SDK (version 3.0.0 or higher)
A code editor (VS Code recommended with Dart extension)

Install Revali#

Add revali to your project's dev dependencies. You can do this in two ways:

Option 1: Using Dart CLI (Recommended)#

dart pub add revali --dev

Option 2: Manual Installation#

Add the following to your pubspec.yaml file:

pubspec.yaml

dev_dependencies:
  revali: ^1.0.0

Install Runtime Dependencies#

For server functionality, you'll also need the runtime dependencies:

dart pub add revali_router

Or add to pubspec.yaml:

pubspec.yaml

dependencies:
  revali_router: ^1.0.0

Get Dependencies#

After adding all dependencies, run:

dart pub get

Verify Installation#

Confirm the CLI resolves and your project's setup is healthy:

dart run revali doctor

Available Constructs#

Server-side code generation (Revali Server) is built into revali — nothing extra to install. Beyond that, Revali supports optional constructs for other use cases:

revali_client: Generate client-side code
revali_docker: Docker deployment support

Browse all available constructs on pub.dev.