Aspire Visual Studio Code extension

The Aspire Visual Studio Code extension provides a set of commands and tools to streamline your work with Aspire within Visual Studio Code. The extension includes commands to create projects, add integrations, configure solutions, and manage deployments. The extension requires the Aspire CLI and provides similar functionality on the Visual Studio Code command palette.

Prerequisites

Before you can use the Aspire Visual Studio Code extension, you need:

• The Aspire CLI installed and available on your PATH

Install the Aspire extension

To install the Aspire VS Code extension:

1. Open VS Code.
2. Open the Extensions view by selecting View > Extensions or pressing Command + Shift + X CmdShiftX Control + Shift + X CtrlShiftX Control + Shift + X CtrlShiftX .
3. Search for “aspire” in the Extensions marketplace.
4. Select the Aspire extension published by Microsoft.
5. Select Install.

Alternatively, you can install the extension directly from the VS Code Marketplace.

Access extension commands

All Aspire extension commands are available from the VS Code Command Palette:

1. Open the Command Palette by pressing Command + Shift + P CmdShiftP Control + Shift + P CtrlShiftP Control + Shift + P CtrlShiftP .
2. Type “Aspire” to filter and display all available Aspire commands.
3. Select the desired command from the list.

All commands are grouped under the Aspire category in the Command Palette for easy discovery.

Available commands

The Aspire VS Code extension provides the following commands:

Command	Description	Availability
Aspire: New Aspire project	Create a new Aspire apphost or starter app from a template.	Available
Aspire: Add an integration	Add a hosting integration (Aspire.Hosting.*) to the Aspire apphost.	Available
Aspire: Configure launch.json	Adds the default Aspire debugger launch configuration to your workspace’s launch.json, which will detect and run the apphost in the workspace.	Available
Aspire: Manage configuration settings	Manage configuration settings including feature flags.	Available
Aspire: Open Aspire terminal	Open an Aspire VS Code terminal for working with Aspire projects.	Available
Aspire: Publish deployment artifacts	Generates deployment artifacts for an Aspire apphost.	Preview
Aspire: Deploy app	Deploy the contents of an Aspire apphost to its defined deployment targets.	Preview
Aspire: Update integrations	Update hosting integrations and Aspire SDK in the apphost.	Preview

Create a new Aspire app

To create a new Aspire app using the extension:

1. Open the Command Palette ( Command + Shift + P CmdShiftP Control + Shift + P CtrlShiftP Control + Shift + P CtrlShiftP ).
2. Run the Aspire: New Aspire project command.
3. Select the desired template.
4. Specify the project name and location.

The extension creates the project and opens it in VS Code.

Add an integration to the Aspire solution

Aspire integrations provide pre-configured connections to various cloud services and dependencies. To add an integration:

1. Open the Command Palette.
2. Run the Aspire: Add an integration command.
3. Browse or search for the desired integration package.
4. Select the integration to add it to your AppHost project.

The extension adds the appropriate NuGet package reference to your AppHost project.

Note

The Add an integration command adds a hosting integration to the AppHost project. It doesn’t add the corresponding client integration to any consuming projects.

Configure an Aspire solution

The Aspire extension includes several commands that configure the behavior of Aspire and the Aspire CLI during development:

Configure launch.json for debugging

To run and debug your Aspire application in VS Code, you need to configure the launch.json file:

1. Open the Command Palette.
2. Run the Aspire: Configure launch.json command.
3. The extension adds a default Aspire debugger configuration to your workspace’s launch.json file.

The default configuration looks like this:

.vscode/launch.json

{
  "type": "aspire",
  "request": "launch",
  "name": "Aspire: Launch Default AppHost",
  "program": "${workspaceFolder}"
}

You can customize the program field to point to a specific AppHost project file. For example:

.vscode/launch.json

{
  "type": "aspire",
  "request": "launch",
  "name": "Aspire: Launch MyAppHost",
  "program": "${workspaceFolder}/MyAppHost/MyAppHost.csproj"
}

Manage configuration settings

The Aspire: Manage configuration settings command executes aspire config request options and displays the results in the VS Code terminal. Use get and set commands to configure the Aspire CLI. Use the list command to show current configuration values.

Run an Aspire solution in development mode

To run your Aspire application in development mode:

1. Ensure you have configured launch.json as described in the Configure launch.json for debugging section.
2. Open the Run and Debug view by selecting View > Run or pressing Command + Shift + D CmdShiftD Control + Shift + D CtrlShiftD Control + Shift + D CtrlShiftD .
3. Select your Aspire launch configuration from the dropdown.
4. Select the green Start Debugging button or press F5 F5 F5 F5 F5 F5 .

The extension builds and starts the AppHost project, launches the Aspire dashboard in your browser, and enables debugging for all resources in your solution.

Alternatively, you can open an Aspire VS Code terminal using Aspire: Open Aspire terminal and run aspire run --start-debug-session to start a VS Code debug session.

Run or debug from the editor

When an AppHost project is detected in your workspace, you can also run or debug it directly from the editor. Use the run buttons in the editor title bar when viewing an AppHost file.

Publish deployment artifacts

Caution

This feature is in Preview.

The Aspire: Publish deployment artifacts command generates deployment artifacts for your Aspire AppHost. This command serializes resources to disk, allowing them to be consumed by deployment tools.

To publish deployment artifacts:

1. Open the Command Palette.
2. Run the Aspire: Publish deployment artifacts command.
3. Select the output location for the generated artifacts.

The command invokes registered publishing callback annotations to generate artifacts such as:

• Bicep files for Azure resources.
• Docker Compose YAML files.
• Kubernetes Helm charts.

For more information about Aspire publishing, see Aspire publishing and deployment overview.

Deploy an Aspire solution

Caution

This feature is in Preview.

The Aspire: Deploy app host command deploys the contents of an Aspire AppHost to its defined deployment targets.

To deploy an Aspire solution:

1. Open the Command Palette.
2. Run the Aspire: Deploy app host command.
3. Follow the prompts to select deployment targets and provide any required configuration.

The command publishes deployment artifacts and then invokes deployment callback annotations to deploy resources to the specified targets.

For more information about Aspire deployment, see Aspire publishing and deployment overview.

Open Aspire terminal

The Aspire: Open Aspire terminal command opens a terminal window configured for working with Aspire projects. This terminal provides easy access to Aspire CLI commands and is preconfigured with the appropriate environment variables.

Feedback and issues

To report issues or request features for the Aspire VS Code extension:

1. Visit the Aspire GitHub repository.
2. Create a new issue and add the area-extension label.