Installation

Prerequisites

The requirements below apply to the version of Neos from which this documentation was generated.
If you use a different version, the requirements may be different.

Visual Studio

Visual Studio is not required, however we recommend using it to edit C# files, projects and solutions generated by Neos.
If you choose to use Visual Studio, you must install Visual Studio 2022 in version 17.4 or higher to support .NET SDK 8.

.NET

Neos requires the .NET 10 SDK and runtime.

.NET SDK

Before installing Neos for the first time, make sure a version of the .NET SDK is installed (even if prior to version 10). This is needed to get the Neos CLI package that will install Neos and the required version of the .NET SDK.
You can check the installed versions by typing the following command:

dotnet --list-sdks

Example :

PS C:\Users\Admin> dotnet --list-sdks
10.0.400 [C:\Program Files\dotnet\sdk]

Be aware that this command does not assure the .NET SDK is installed even if one version is listed.
To make sure a version is really installed, copy the path next to it, open it in your file explorer and open the corresponding directory. If it is empty, this means the SDK was probably uninstalled by an update.

Before the first installation of Neos, if no version of the .NET SDK is installed, you need to install one manually.

Node.js

Node.js version 22.12 or higher must be installed. You can check the installed version by typing the following command:

node --version

You can install it by typing the following command:

winget install -e --id OpenJS.NodeJS.LTS

You can update it by typing the following command:

winget update -e --id OpenJS.NodeJS.LTS

Public packages feed

Neos packages are in a public packages feed.

NuGet packages

To be able to download the NuGet packages, you have to add the source by typing the following command:

dotnet nuget add source "https://pkgs.dev.azure.com/POLE-ERP-GROUPEISA/Neos-Public/_packaging/Neos-Public/nuget/v3/index.json" -n "Neos-Public"

Neos CLI

Installation

Neos CLI contains all the necessary commands to manage a cluster. For more information, see the Neos CLI.

To install it, type the following command:

dotnet tool install GroupeIsa.Neos.Console --global --ignore-failed-sources --no-cache --interactive --verbosity minimal

After the first installation, you must set up the development environment by running the setup command as an administrator.

Update

If the tool is already installed, you can updated it by typing the following command:

dotnet tool update GroupeIsa.Neos.Console --global --ignore-failed-sources --no-cache --interactive --verbosity minimal

After each update, you must set up the development environment by running the setup command as an administrator.

Setup

After the first installation and each update, you must set up the development environment by running the following command as an administrator:

neos setup

Important

The command can launch installation programs that create environment variables (e.g. dapr). After initializing Neos with the neos setup command, you'll need to use a new terminal for these to be usable.

Troubleshooting

If you have problems with the installation, see the troubleshooting page.

Neos Studio VS Code extension

The Neos Studio VS Code extension is a Visual Studio Code extension that brings Neos Studio functionality directly into VS Code. It allows you to manage your cluster's modules metadata, browse entity views, and interact with your Neos environment without leaving your code editor. See the Neos Studio VS Code extension article for installation steps and usage details.