4 minutes to read
Created by
Calytic
Updated by
Wulf

Installation

Details on how to install uMod

Prerequisites

uMod Installer

Windows via uMod Installer

The uMod Installer may be downloaded from the download page and will install the required .NET SDK, the global uMod tool, and the uMod templates automatically. Once installed, the umod command will be available globally from the command-prompt or terminal.

Windows via PowerShell script

Download umod-install PowerShell script:

Invoke-WebRequest https://umod.io/umod-install.ps1 -OutFile umod-install.ps1

Install .NET 5.0 and uMod global tool:

./umod-install.ps1

Linux via Bash script

Get the umod-install bash script:

wget -q https://umod.io/umod-install.sh

Set the umod-install script as executable:

chmod +x umod-install.sh

Install .NET 5.0 and uMod global tool:

./umod-install.sh

Use the new dotnet and umod commands immediately by reading the bash profile

. ~/.profile

.NET installation

Linux via Shell

Install .NET 5.0 with this one-liner:

curl -sSL https://umod.io/dotnet-install.sh | bash /dev/stdin --channel 5.0

Linux (apt) via package manager

Add Microsoft package repository:

Ubuntu 20.10:

wget -q https://packages.microsoft.com/config/ubuntu/20.10/packages-microsoft-prod.deb

Ubuntu 20.04:

wget -q https://packages.microsoft.com/config/ubuntu/20.04/packages-microsoft-prod.deb

Ubuntu 18.04:

wget -q https://packages.microsoft.com/config/ubuntu/18.04/packages-microsoft-prod.deb

Decompress the Microsoft packages file:

sudo dpkg -i packages-microsoft-prod.deb

Update the available packages:

sudo apt-get update

Install the .NET SDK package:

sudo apt-get install apt-transport-https dotnet-sdk-5.0

If the error occurs Unable to locate package dotnet-sdk, see Troubleshoot the Package Manager.

Linux (yum) via package manager

Install the .NET SDK package:

sudo yum install dotnet-sdk-5.0 -y

Windows via PowerShell

Download dotnet-install PowerShell script:

Invoke-WebRequest https://umod.io/dotnet-install.ps1 -OutFile dotnet-install.ps1

Install .NET 5.0:

./dotnet-install.ps1 -Channel 5.0

Windows manual installation

Download and install .NET (5.0) SDK (x64) from Microsoft.

uMod tool installation

Once the prerequisite .NET SDK is installed, add the uMod nuget source:

dotnet nuget add source https://www.myget.org/f/umod/api/v3/index.json --name uMod

Install the uMod Agent:

dotnet tool install -g uMod --version "*-*"

Install the uMod templates with:

dotnet new -i "uMod.Templates::*-*"

Simple examples

PowerShell

Obtain script and install uMod with this one-liner:

&powershell -NoProfile -ExecutionPolicy unrestricted -Command "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12;&([scriptblock]::Create((Invoke-WebRequest -UseBasicParsing 'https://umod.io/umod-install.ps1')))"

Bash

Obtain script and install uMod with this one-liner:

curl -sSL https://umod.io/umod-install.sh | bash /dev/stdin
. ~/.profile