Skip to main content
Version: Next

Introduction to the Serverpod CLI

The Serverpod CLI (serverpod) creates projects, generates server and client code, and manages your database migrations from the command line. This reference covers every command, option, and flag.

Install the CLI​

Install the CLI with Dart before running any command:

dart install serverpod_cli

See Installation for the full setup, including the prerequisites.

Command syntax​

Every serverpod invocation follows the same shape:

serverpod [global options] <command> [<subcommand>] [arguments] [options]

Run serverpod help to list the commands, or serverpod help <command> for the options of a single command.

Global options​

A small set of options applies to every command: output verbosity (-q / --quiet, -v / --verbose), analytics (-a / --analytics), interactive prompts (--interactive), and experimental features (--experimental-features). The full list lives on the Global options page.

Environment variables​

The CLI reads a single environment variable, described on the Environment variables page.

How this reference is organized​

Most command pages combine a hand-written introduction with the auto-generated subcommand and option listings drawn from serverpod help. The sidebar lists commands alphabetically. Use the search box for fast lookup by flag or argument name.