Skip to content

[docs] Document installing the Aspire CLI as a NativeAOT .NET tool #842

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
radical wants to merge 1 commit into
base: main
Choose a base branch
from
+19 −1
Open

[docs] Document installing the Aspire CLI as a NativeAOT .NET tool #842

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion src/frontend/src/content/docs/get-started/install-cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Install Aspire CLI
description: Learn how to install the Aspire CLI as a native executable or .NET global tool to manage your cloud-native applications.
description: Learn how to install the Aspire CLI as a native executable or NativeAOT .NET tool to manage your cloud-native applications.
lastUpdated: true
tableOfContents: true
Comment on lines 1 to 5
---
Expand Down Expand Up @@ -43,6 +43,24 @@ At any time, you can reopen the **Install Aspire CLI** command modal from the to

You only need to download the script separately if you want to inspect it or run the installer as separate commands. For more information, see the [aspire-install script reference](/reference/cli/install-script/).

## Install as a NativeAOT .NET tool

<Aside type="note">
This install method was introduced in Aspire 13.3.
</Aside>

The Aspire CLI is also published as a NativeAOT [.NET tool](https://learn.microsoft.com/dotnet/core/tools/global-tools). This install method requires the .NET SDK 10.0.100 or later.
Comment on lines +46 to +52

```bash title="Install the Aspire CLI as a NativeAOT .NET tool"
dotnet tool install -g Aspire.Cli
```

Self-update via `aspire update --self` is disabled for .NET tool installs. Update the CLI through the .NET SDK instead:

```bash title="Update the Aspire CLI"
dotnet tool update -g Aspire.Cli
```

## Validation

To validate that the Aspire CLI is installed, use `aspire --version` to query Aspire CLI for a version number:
Expand Down
Loading