Installation

Finch is a server-side web framework for Dart. This page covers the prerequisites and steps to install it.

Prerequisites

• Dart SDK — Finch requires Dart 3.x or later. Download from dart.dev/get-dart.
• A terminal and a text editor (VS Code with the Dart extension is recommended).

Install the Finch CLI

The Finch CLI provides project scaffolding, build, serve, and migration commands.

dart pub global activate finch

After activation, verify the installation:

finch --version

Create a New Project

finch create

You will be prompted to choose a project name, path, and template. The example template includes MongoDB, MySQL, SQLite, WebSocket, i18n, forms, and API documentation examples.

Add Finch to an Existing Project

dart pub add finch

Then run:

dart pub get

Next Step

See Finch CLI for all available commands, or jump to Configuration to set up your first application.