aspire Documentation

1. Project Overview & Quickstart (microsoft/aspire) Copy Chapter

Aspire

What is Aspire? Copy Chapter

Aspire is a multi-language, code-first toolchain for building, running, and deploying distributed applications.

Describe how services, frontends, containers, databases, caches, and connections fit together in code. The Aspire CLI runs the whole app locally, exposes OpenTelemetry-based observability, and carries the same definition into deployment.

A simple app definition Copy Chapter

The same application definition can be written in different languages.

C# (apphost.cs)

var builder = DistributedApplication.CreateBuilder(args);

var cache = builder.AddRedis("cache");

var api = builder.AddNodeApp("api", "./api", "src/index.ts")
        .WithReference(cache)
        .WaitFor(cache)
        .WithHttpEndpoint(env: "PORT")
        .WithExternalHttpEndpoints();

builder.AddViteApp("frontend", "./frontend")
    .WithReference(api)
    .WaitFor(api);

builder.Build().Run();

TypeScript (apphost.ts)

import { createBuilder } from './.aspire/modules/aspire.js';

const builder = await createBuilder();

const cache = await builder.addRedis("cache");

const api = await builder
    .addNodeApp("api", "./api", "src/index.ts")
    .withReference(cache)
    .waitFor(cache)
    .withHttpEndpoint({ env: "PORT" })
    .withExternalHttpEndpoints();

await builder
    .addViteApp("frontend", "./frontend")
    .withReference(api)
    .waitFor(api);

await builder.build().run();

Getting started Copy Chapter

Install the Aspire CLI Copy Section

To install the latest released version of the Aspire CLI:

On Windows:

irm https://aspire.dev/install.ps1 | iex

On Linux or macOS:

curl -sSL https://aspire.dev/install.sh | bash

[!NOTE]
If you want to use the latest daily builds instead of the released version, follow the instructions in docs/using-latest-daily.md.

Useful links Copy Chapter

• Documentation
• Build your first app
• Build status
• Aspire samples repository
• Developer Control Plane (DCP)
• Dogfooding pull requests

What is in this repo? Copy Chapter

This repo contains the Aspire CLI, AppHost SDK, dashboard, service discovery infrastructure, project templates, integrations, and VS Code Extension.

Contributing Copy Chapter

Follow docs/contributing.md for working in the repository.

Reporting security issues and security bugs Copy Chapter

Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) [email protected]. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the MSRC PGP key, can be found in the Security TechCenter. You can also find these instructions in this repo's Security doc.

Note on containers used by Aspire resource and client integrations Copy Section

The Aspire team cannot evaluate the underlying third-party containers for which it provides API support for suitability for specific customer requirements.

You should evaluate whichever containers you chose to compose and automate with Aspire to ensure they meet your, your employers or your government’s requirements on security and safety as well as cryptographic regulations and any other regulatory or corporate standards that may apply to your use of the container.

License Copy Chapter

The code in this repo is licensed under the MIT license.

2. Official Technical Reference & Guides (microsoft/microsoft.github.io) Copy Chapter

[microsoft.github.io](https://microsoft.github.io)

Many open source projects released by Microsoft products, services and teams also have
deployments powered by GitHub Pages on this domain.

To discover Microsoft-released open source projects, learn about Microsoft's open source
approach and other information, check us out online at opensource.microsoft.com.

If we can help answer questions about the open source program at Microsoft, you can
contact opensource at microsoft com - although we are not able to provide support
for projects through this mechanism.

Microsoft GitHub resources Copy Chapter

• Default repo templates including SECURITY.MD and code of conduct files: microsoft/repo-templates
• Code of Conduct (FAQ)

Microsoft open source resources Copy Chapter

• Open Source Blog
• The Open Source Show on Channel 9
• https://opensource.microsoft.com/

Resources for Microsoft employees Copy Chapter

• docs.opensource.microsoft.com
• Link your GitHub Account and join GitHub organizations automatically

How to identify an official Microsoft organization on GitHub Copy Chapter

• Official Microsoft GitHub orgs have a professional avatar and include a web address at Microsoft.com or an associated official domain
• Official Microsoft orgs are Verified on GitHub - look for the domain verification indicator on GitHub