@mastra/deployer-netlify

A Netlify deployer for Mastra applications.

Features

• Deploy Mastra applications to Netlify Functions
• Automatic site creation and configuration
• Serverless function support with Edge Functions
• Zero-configuration deployments

Installation

1pnpm add @mastra/deployer-netlify

Usage

The Netlify deployer is used as part of the Mastra framework:

1import { Mastra } from '@mastra/core';
2import { NetlifyDeployer } from '@mastra/deployer-netlify';
3
4const deployer = new NetlifyDeployer({
5  scope: 'your-team-id',
6  projectName: 'your-project-name',
7  token: 'your-netlify-token',
8});
9
10const mastra = new Mastra({
11  deployer,
12  // ... other Mastra configuration options
13});

Configuration

Constructor Options

• scope (required): Your Netlify team slug or ID
• projectName: Name of your Netlify site (will be created if it doesn't exist)
• token: Your Netlify authentication token

Project Structure

The deployer automatically creates the following structure:

your-project/
├── netlify/
│   └── functions/
│       └── api/
└── netlify.toml

netlify.toml Configuration

The deployer creates a netlify.toml with the following defaults:

1[functions]
2node_bundler = "esbuild"
3directory = "/netlify/functions"
4
5[[redirects]]
6force = true
7from = "/*"
8status = 200
9to = "/.netlify/functions/api/:splat"

Environment Variables

Environment variables are handled automatically through:

• .env files in your project
• Environment variables passed through the Mastra configuration
• Netlify's environment variable UI

Deployment Process

The deployer will:

1. Create a new site if it doesn't exist
2. Configure the site with your environment variables
3. Deploy your application to Netlify Functions