Skip to main content
Version: Next

Installation

Prerequisites

Serverpod is tested on Mac, Windows, and Linux. Before you can install Serverpod, you need to have Flutter installed.

info

Check your Flutter installation by running the following command in your terminal:

$ flutter doctor

Install Serverpod

Serverpod is installed using the Dart package manager. To install Serverpod, run the following command in your terminal:

$ dart install serverpod_cli 3.5.0-beta.9

This command will install the Serverpod command-line interface (CLI) globally on your machine. You can verify the installation by running:

$ serverpod version

If everything is correctly configured, the help for the serverpod command is now displayed.

warning

If the Serverpod CLI is already installed globally, deactivate it before installing or upgrading:

$ dart pub global deactivate serverpod_cli

The Serverpod VS Code extension makes it easy to work with your Serverpod projects. It provides real-time diagnostics and syntax highlighting for model files in your project.

Serverpod extension

You can install the extension from the VS Code Marketplace or search for Serverpod from inside VS Code.

Install Serverpod Insights (optional)

Serverpod Insights is a companion app bundled with Serverpod. It allows you to access your server's logs and health metrics. Insights is available for Mac and Windows, but we will be adding support for Linux in the future. Serverpod Insights