Install, update and run

The Entity Services CLI (Entity Services App Builder) can be installed in Windows, macOS, and Linux environments. It can also be run in a Docker container.

The Entity Services client command-line app can be installed as a dotnet tool from Entity Services package repository.

Prerequisites

Install .NET

Entity Services App Builder is built on a free, cross-platform, open source developer platform .NET. To use it, if it’s not already installed, download and install the .NET runtime on your computer.

Shorter: If it’s not already installed, install .NET 6:

Open a terminal such as PowerShell, Command Prompt, or bash and execute:

Windows

         winget install Microsoft.DotNet.Runtime.6

Linux

     sudo apt-get install -y dotnet-runtime-6.0         

Install Azure Artifacts Credential Provider

Entity Services CLI is available at public nuget source.

Add EntityServices as a package source

Entity Services CLI is available from Entity Services nuget source, so if it’s not already in your NuGet source list, run command:

dotnet nuget add source https://pkgs.dev.azure.com/entityservices/nugets-lite/_packaging/es-lite/nuget/v3/index.json --name entityservices 

Install

To install Entity Services CLI app as a dotnet tool from Entity Services package repository:

dotnet tool install es-builder-cli -g

This command will enable the features necessary to run Entity Services App Builder. Once you have installed Entity Services CLI, you will need to authenticate. See the usage examples to learn more.

Check version

You can check the version of existing Entity Services CLI:

dotnet tool list es-builder-cli -g

Update

To update installed es-builder to the latest version:

dotnet tool update es-builder-cli -g 

Uninstall

To uninstall Entity Services CLI:

dotnet tool uninstall --global es-builder-cli