Skip to content
Aspire.Hosting.Netlify

Install

Aspire.Hosting.Netlify is published to NuGet.org as IEvangelist.Aspire.Hosting.Netlify (the Aspire.* prefix is reserved by Microsoft) and targets net10.0 with a floating dependency on Aspire.Hosting 13.2.x.

Prerequisites

Section titled “Prerequisites”
  • .NET 10 SDK — confirm with dotnet --info. The integration ships with the Aspire.AppHost.Sdk 13.2.4 SDK and requires .NET 10.
  • Aspire CLI — install via winget install Microsoft.Aspire (Windows), brew install aspire (macOS), or follow the install.sh script on Linux. Confirm with aspire --version.
  • Node.js 20+ — needed by your frontend apps and by the Netlify CLI.
  • Netlify CLI — the integration auto-installs netlify-cli globally if it isn’t already on PATH. You can pre-install it yourself with npm install -g netlify-cli.

Add the package

Section titled “Add the package”

The Aspire CLI knows how to add hosting integrations to either a C# or a TypeScript AppHost — use that instead of dotnet add package so the right integration metadata flows into your AppHost project.

Terminal window
aspire add IEvangelist.Aspire.Hosting.Netlify

If you’re starting from scratch, scaffold an AppHost first:

Terminal window
mkdir MyAppHost && cd MyAppHost
aspire init
aspire add IEvangelist.Aspire.Hosting.Netlify
aspire add Aspire.Hosting.JavaScript

For a TypeScript AppHost, choose TypeScript when aspire init prompts. aspire add regenerates the .modules/ surface so the integration’s exports become available to your apphost.ts.

Verify

Section titled “Verify”

Run any AppHost that references the package and you should see no missing references when you call PublishAsNetlifySite(...):

using Aspire.Hosting;
using Aspire.Hosting.JavaScript;


var builder = DistributedApplication.CreateBuilder(args);


builder.Pipeline.AddNetlifyDeployPipeline();


builder.AddJavaScriptApp("astro", "../astro")
    .PublishAsNetlifySite("dist");


builder.Build().Run();

Next steps

Section titled “Next steps”