Installation
Prerequisites
The requirements below apply to the version of Neos from which this documentation was generated. If you are on 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 7.
.NET
Neos requires the .NET 8 SDK and runtime. You can check the installed versions by typing the following command:
dotnet --list-sdks
Example :
PS C:\Users\Admin> dotnet --list-sdks
6.0.419 [C:\Program Files\dotnet\sdk]
7.0.406 [C:\Program Files\dotnet\sdk]
8.0.201 [C:\Program Files\dotnet\sdk]
Your .NET 8 SDK must be in version 8.0.2xx.
If you do not see a version 8.0.2xx listed, you need to install it.
If you see a 8.0.2xx version listed, copy the path next to it, open in in your file explorer and open the 8.0.2xx directory. If it is empty, the SDK was probably uninstalled by an update an needs to be reinstalled.
The .NET 8 runtime should be installed when installing the SDK. You can check the installed versions by typing the following command:
dotnet --list-runtimes
Example :
PS C:\Users\Admin> dotnet --list-runtimes
Microsoft.AspNetCore.App 6.0.27 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.AspNetCore.App 7.0.16 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.AspNetCore.App 8.0.2 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.NETCore.App 6.0.27 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 7.0.16 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 8.0.2 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.WindowsDesktop.App 6.0.27 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]
Microsoft.WindowsDesktop.App 7.0.16 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]
Microsoft.WindowsDesktop.App 8.0.2 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]
Your .NET 8 runtime must be in version 8.0.xx, and it must match the SDK version. You can find which version matches the SDK version here. For example, the runtime version 8.0.2 matches the SDK version 8.0.201.
As with the SDK, if you do not see the right version listed, or if one of the listed directories for the version is empty, you need to install it.
Node.js
Node.js version 20 or higher must be installed. You can check the installed version by typing the following command:
node --version
WSL (Windows Subsystem for Linux)
You must have Windows Subsystem for Linux. You can find details of this installation here.
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
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
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
During the first installation, the command gives you a URL with a code.
Open the URL in a web browser, enter the code in the page and answer "Yes" to the message asking if the authentication was done from Visual Studio.
There is no feedback in the terminal but the installation is in progress.
After the installation and each update, you must setup the development environment by running the following command as an administrator:
neos setup
If you have problems with the installation, see the troubleshooting page.