Skip to main content

Install on Windows

Install 'hypermass' command​

You can download the latest pre-compiled binaries from the Releases Page.

Choose the windows_amd64.zip for standard 64-bit PCs or windows_arm64.zip for Surface/ARM-based devices.

A note on upgrading: If you're upgrading an existing installation, simply replace the binary file you created previously with the new binary (e.g., C:\tools\hypermass\hypermass.exe).

Extract and Locate​

  1. Right-click the downloaded .zip and select Extract All.
  2. Add security exception
    1. Right-click hypermass.exe and select Properties.
    2. At the bottom of the General tab, look for a "Security" section that says: "This file came from another computer and might be blocked..."
    3. Check the Unblock box and hit Apply/OK.
  3. Move the hypermass exe file to a permanent folder (e.g., C:\tools\hypermass\ - so the full file path is C:\tools\hypermass\hypermass\hypermass.exe).

Add to System PATH​

To run hypermass from any terminal window (Command Prompt or PowerShell):

  1. Open the Start Menu, search for "Edit the system environment variables", and open it.
  2. Click the Environment Variables button.
  3. Under User variables, select Path and click Edit.
  4. Click New and paste the path to your folder (e.g., C:\tools\hypermass).
  5. Click OK on all windows.
  6. Restart any open terminals.

Verify​

Open a new terminal and run;

hypermass

You should see the command documentation.

Done!

Now that the command is installed, we suggest going to this page; Using the CLI

Optional: Adding a Sync service (Server mode)​

If you're installing hypermass on a server to integrate into a system, you will likely want to run the "hypermass sync" as a background task.

For a "headless" background experience that starts automatically when you log in and restarts if it fails:

  1. Open PowerShell as Administrator.
  2. Run the following script (replace C:\tools\hypermass\hypermass.exe with your actual path):
$exePath = "C:\tools\hypermass\hypermass.exe"

if (Test-Path $exePath) {
    $action = New-ScheduledTaskAction -Execute $exePath -Argument "sync"
    $trigger = New-ScheduledTaskTrigger -AtLogOn
    $settings = New-ScheduledTaskSettingsSet -RestartCount 3 -RestartInterval (New-TimeSpan -Minutes 1)

    Register-ScheduledTask -Action $action `
                           -Trigger $trigger `
                           -Settings $settings `
                           -TaskName "HypermassSync" `
                           -Description "Keep local folders synced with Hypermass nodes." `
                           -Force

    Start-ScheduledTask -TaskName "HypermassSync"
    Write-Host "Task registered and started successfully." -ForegroundColor Green
} else {
    Write-Error "Could not find hypermass.exe at $exePath. Please check the path and try again."
}
Done!

Now that the command is installed, we suggest going to this page; Using the CLI