Installation

Get Aim installed and set up your development environment.

Prerequisites

• Dart SDK 3.13.0 or higher
• A code editor (VS Code, IntelliJ IDEA, etc.)

Using Aim CLI (Recommended)

The easiest way to start a new project is using the Aim CLI:

# Install the Aim CLI
dart install aim_cli

# Create a new project
aim create my_app

# Navigate to the project
cd my_app

# Install dependencies
dart pub get

# Start the development server
aim dev

The CLI will:

• Create a new Dart project with the correct structure
• Install dependencies
• Set up a basic application
• Start the development server with hot reload

Cloudflare Workers

To target Cloudflare Workers instead of the Dart VM, pass --target workers:

aim create my_worker --target workers
cd my_worker
dart pub get
aim dev   # compiles to WebAssembly and starts wrangler dev

This requires Node.js (the CLI runs npx wrangler@4). See Cloudflare Workers for bindings, deployment, and what differs from the VM.

Supabase Edge Functions

To target Supabase Edge Functions, pass --target supabase:

aim create my_api --target supabase
cd my_api
dart pub get
aim dev   # compiles to WebAssembly, starts the local Supabase stack if it
          # is not already running, then supabase functions serve

This requires the Supabase CLI and a running Docker daemon.

See Supabase Edge Functions for prerequisites, deployment, and how the function name affects routing.

Cloud Functions

To target Cloud Functions for Firebase, pass --target functions:

aim create my_api --target functions
cd my_api
dart pub get
aim dev   # starts the Firebase emulator

aim build does nothing for this target — the Firebase CLI itself compiles your app during firebase deploy --only functions. See Cloud Functions for Firebase for the full setup; Dart support there is experimental.

Manual Setup

If you prefer to set up manually:

1. Create a new Dart project:

dart create my_app
cd my_app

2. Add Aim to your pubspec.yaml:

dependencies:
  aim_server: ^0.4.0

dev_dependencies:
  lints: ^5.0.0

3. Install dependencies:

dart pub get

Next Steps

Now that you have Aim installed, head over to the Quick Start guide to build your first application.