Skip to main content

Installation Guide

This guide walks you through installing Oidis Builder and setting up a development environment. Tested on Windows 10/11 and Linux (Ubuntu 22.04, 24.04).

Prerequisites​

You only need Git installed before starting.

Download and install Git for Windows.

tip

Node.js, MongoDB, and other runtime dependencies are bundled with Oidis Builder — you do not need to install them separately.

Step 1: Install Oidis Builder​

Download and run the PowerShell updater script:

# Download the updater to your desired installation directory
Invoke-WebRequest -Uri "https://hub.oidis.io/Download/builder-updater.ps1" -OutFile "builder-updater.ps1"

# Run the updater — Builder will be installed in the current directory
.\builder-updater.ps1
note

If PowerShell blocks the script due to execution policy, run Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy RemoteSigned first, or use the manual installation below.

Manual installation​

Download the Builder package directly from Oidis Hub:

Extract the archive to any directory.

warning

Avoid deeply nested paths on Windows — long paths can cause issues with some tools.

Step 2: Add to PATH​

Add <builder-installation-dir>\cmd to your system PATH using the Environment Variables editor. Then restart your terminal.

Step 3: Verify​

Open a new terminal and run:

oidis --version

You should see the installed Builder version. If you get "command not found", check that the PATH is set correctly and that you opened a new terminal after changing it.

Optional: Builder configuration​

To customize Builder behavior, create OidisBuilder.config.jsonp in the Builder installation directory:

Io.Oidis.Builder.DAO.Resources.Data({
    noReport: true    // Disable crash reporting
})

Next steps​

  1. Project Setup — clone a project and install dependencies
  2. Oidis Builder Quick Start — learn the daily commands
  3. IDE Configuration — set up IntelliJ / WebStorm

See also: Project Setup | IDE Configuration