prerequisites.mdx

title	Prerequisites
description	Learn about essential tooling concepts for Aspire.
giscus	false
tableOfContents	minHeadingLevel maxHeadingLevel 1 5
lastUpdated	true

import { Aside, Icon, Code, CardGrid, Card, LinkCard, LinkButton, Steps, Tabs, TabItem } from '@astrojs/starlight/components'; import IconAside from '@components/IconAside.astro'; import IconLinkCard from '@components/IconLinkCard.astro'; import CodespacesButton from '@components/CodespacesButton.astro'; import OsAwareTabs from '@components/OsAwareTabs.astro'; import PivotSelector from '@components/PivotSelector.astro'; import Pivot from '@components/Pivot.astro';

Ready to dive into Aspire? Before you begin, make sure your development environment is set up with a few essential tools. This guide walks you through everything you need to start building and running Aspire solutions with confidence.

<PivotSelector title="Choose your AppHost language" key="apphost" options={[ { id: "csharp", title: "C#" }, { id: "typescript", title: "TypeScript" }, ]} />

1. Install your language runtime

   .NET SDK

   Aspire's C# AppHost is built on .NET, a free, open-source, cross-platform framework for building modern apps and cloud services. You'll need the .NET 10.0 SDK installed—no prior C# experience is required.

   The .NET 10.0 SDK is required for C# AppHosts. However, Aspire can run applications targeting .NET 8.0 or later.

   Follow the installation instructions for your operating system (Windows, macOS, or Linux) to complete the setup.

   Node.js

   Aspire's TypeScript AppHost requires Node.js 20 or later (LTS recommended) and a package manager such as npm or pnpm.

   Follow the Node.js installation instructions for your operating system (Windows, macOS, or Linux) to complete the setup.

2. Install an OCI-compliant container runtime

   Aspire can run containers using several OCI-compatible runtimes, including Docker Desktop and Podman.

   • Docker Desktop is the most popular container runtime among Aspire developers, offering a familiar and widely supported environment for building and running containers.

   • Podman is an open-source, daemonless alternative to Docker. It supports building and running Open Container Initiative (OCI) containers, making it a flexible choice for developers who prefer a lightweight solution.

   • Rancher Desktop has been reported by users as a successful alternative—particularly when configured to use the Docker CLI. However, Rancher Desktop is not an officially supported or regularly tested scenario for Aspire. If you encounter issues with Rancher Desktop, please let us know, but fixes may not be prioritized.

3. Install an integrated development environment (IDE)

   Aspire supports multiple IDEs and code editors. You can choose the one that best fits your workflow:

   We recommend [Visual Studio Code](https://code.visualstudio.com/) for the best experience—a lightweight, cross-platform code editor with excellent Aspire support. Install the following extensions to get started:
   1. Aspire extension for Aspire-specific commands and features.

   Additionally, install the C# extension for C# language support.

   Aspire also works well with:

   • Visual Studio: A full-featured IDE for C# development with debugging, IntelliSense, and Git support.
   • JetBrains Rider: A powerful, cross-platform C# IDE with advanced features like code analysis, refactoring, and debugging.

4. Consider alternatives to local installation

   If you prefer not to install the prerequisites on your local machine, you can develop Aspire solutions using cloud-based options like GitHub Codespaces or Dev Containers. These options allow you to work in a cloud-based environment, eliminating the need for local installations, but may not provide the same performance as local installations.

   The Aspire team maintains a GitHub Codespaces (with preconfigured Dev Container) configuration to help you get started quickly: