HYPHAby S33D
Documentation › Install the agent

Install the agent on Windows

A Windows service, "Hypha Agent", that reads performance counters, event logs and services.

Requirements

Install in one command

[Net.ServicePointManager]::SecurityProtocol = [Net.ServicePointManager]::SecurityProtocol -bor 3072; $env:HYPHA_API_KEY='hph_your_key'; iwr -useb https://hypha.s33d.fr/install/install.ps1 | iex

The start of the line enables TLS 1.2, which PowerShell 5.1 lacks by default on Windows Server 2016 and 2019. The Settings › Install the agent page gives this command ready to paste.

The script downloads hypha-agent.exe to C:\Program Files\Hypha, checks its SHA-256 sum, writes C:\ProgramData\Hypha\hypha.yaml, then installs and starts the Hypha Agent service (short name HyphaAgent), automatic start, LocalSystem account, restarted on failure.

The variables HYPHA_URL, HYPHA_TAGS, HYPHA_HOSTNAME and HYPHA_FORCE_CONF work as on Linux.

Check

& "C:\Program Files\Hypha\hypha-agent.exe" status
& "C:\Program Files\Hypha\hypha-agent.exe" check-config
Get-Service HyphaAgent

What the agent collects by default

On a desktop edition, stopped services are not reported by default: set checks.windows_auto_services: always to follow them.

Antivirus software

Some antivirus products hold or refuse the first launch of an executable they do not know. If an installation or an update fails with "Access denied", allow C:\Program Files\Hypha\hypha-agent.exe. During an automatic update, the agent waits up to 3 minutes for the new binary to answer; otherwise it keeps the old one and tries again an hour later, three times at most.

Update

Run the install command again, or let the fleet update itself with auto_update: true: see Fleet and updates.

Uninstall

$env:HYPHA_UNINSTALL='1'; iwr -useb https://hypha.s33d.fr/install/install.ps1 | iex

The service and the binary are removed. C:\ProgramData\Hypha (configuration and state) stays in place.

Updated: 19 November 2026