mirror of
https://github.com/nesquena/hermes-webui.git
synced 2026-05-25 03:00:23 +00:00
055f9b3cd0
Squashed from 2 author commits onto current master (3 base commits from already-shipped #2783 were filtered out by the squash): -f53b9308fix(start.ps1): TryParse HERMES_WEBUI_PORT + exit AFTER try/finally cleanup -7b6e0722fix(start.ps1): drop non-functional @args splat under [CmdletBinding()] Authorship preserved. CHANGELOG entry merged into batch stamp commit.
207 lines
8.9 KiB
PowerShell
207 lines
8.9 KiB
PowerShell
<#
|
|
.SYNOPSIS
|
|
Native Windows launcher for Hermes WebUI - PowerShell equivalent
|
|
of start.sh, bypassing bootstrap.py's platform refusal.
|
|
|
|
.DESCRIPTION
|
|
Mirrors start.sh's discovery: load optional .env, find Python,
|
|
locate the hermes-agent install, set sensible env defaults, then
|
|
invoke server.py directly. The bootstrap.py path is skipped
|
|
because it currently raises on platform.system() == 'Windows';
|
|
server.py itself runs cleanly on native Windows.
|
|
|
|
Assumes Python + hermes-agent + the WebUI Python deps are already
|
|
installed natively on Windows - same assumption start.sh makes
|
|
when invoked outside a fresh bootstrap. For first-time setup, the
|
|
native Windows path is to install Python 3.11+, then create a
|
|
Windows venv (`python -m venv venv`) and `pip install -r
|
|
requirements.txt` from the hermes-agent root in PowerShell - this
|
|
script then finds `venv\Scripts\python.exe` automatically. A venv
|
|
created inside WSL2 is a Linux virtual environment (`venv/bin/python`)
|
|
and cannot be used by native Windows Python, so the bootstrap.py-
|
|
inside-WSL2 path produces a venv `start.ps1` can't invoke.
|
|
|
|
.PARAMETER Port
|
|
TCP port the WebUI binds to. Overrides HERMES_WEBUI_PORT env.
|
|
Default: 8787.
|
|
|
|
.PARAMETER BindHost
|
|
Bind address. Overrides HERMES_WEBUI_HOST env.
|
|
Default: 127.0.0.1.
|
|
|
|
.EXAMPLE
|
|
.\start.ps1
|
|
# Bind to 127.0.0.1:8787, foreground.
|
|
|
|
.EXAMPLE
|
|
.\start.ps1 -Port 9000
|
|
# Bind to 127.0.0.1:9000.
|
|
|
|
.EXAMPLE
|
|
$env:HERMES_WEBUI_HOST = '0.0.0.0'
|
|
.\start.ps1
|
|
# Bind to all interfaces (set a password first via env or Settings).
|
|
|
|
.LINK
|
|
https://github.com/nesquena/hermes-webui/issues/1952
|
|
#>
|
|
|
|
[CmdletBinding()]
|
|
param(
|
|
[int]$Port = 0,
|
|
[string]$BindHost = ''
|
|
)
|
|
|
|
$ErrorActionPreference = 'Stop'
|
|
$RepoRoot = Split-Path -Parent $PSCommandPath
|
|
|
|
# === Load .env (mirroring start.sh's filtering) ========================
|
|
$envFile = Join-Path $RepoRoot '.env'
|
|
if (Test-Path $envFile) {
|
|
foreach ($line in Get-Content $envFile -Encoding UTF8) {
|
|
$trimmed = $line.Trim()
|
|
if (-not $trimmed -or $trimmed.StartsWith('#') -or -not $trimmed.Contains('=')) { continue }
|
|
$kv = $trimmed -split '=', 2
|
|
$key = ($kv[0].Trim() -replace '^export\s+', '')
|
|
# Filter out shell-readonly vars (UID, GID, EUID, EGID, PPID) per start.sh
|
|
if ($key -in @('UID', 'GID', 'EUID', 'EGID', 'PPID')) { continue }
|
|
if ($key -notmatch '^[A-Za-z_][A-Za-z0-9_]*$') { continue }
|
|
# Explicit $null check — an env var explicitly set to '' should still
|
|
# be considered "set" and NOT overridden by .env (empty string is
|
|
# falsey in PowerShell, so a plain truthy check would mis-skip).
|
|
if ($null -ne [Environment]::GetEnvironmentVariable($key)) { continue }
|
|
$val = $kv[1]
|
|
if ($val -match '^"(.*)"$') { $val = $Matches[1] }
|
|
elseif ($val -match "^'(.*)'$") { $val = $Matches[1] }
|
|
[Environment]::SetEnvironmentVariable($key, $val)
|
|
}
|
|
}
|
|
|
|
# === Find Python (matches start.sh order) ==============================
|
|
$Python = $env:HERMES_WEBUI_PYTHON
|
|
if (-not $Python) {
|
|
foreach ($candidate in @('python3', 'python', 'py')) {
|
|
$cmd = Get-Command $candidate -ErrorAction SilentlyContinue
|
|
if ($cmd) { $Python = $cmd.Source; break }
|
|
}
|
|
}
|
|
if (-not $Python) {
|
|
Write-Error 'Python 3 is required to run server.py (set HERMES_WEBUI_PYTHON or add python to PATH).'
|
|
exit 1
|
|
}
|
|
|
|
# === Find Hermes Agent dir (server.py imports from it) =================
|
|
# When HERMES_WEBUI_AGENT_DIR is set we still validate it on disk —
|
|
# an explicit override pointing at a missing dir should fail FAST
|
|
# with a clear message, not silently progress into a python3 launch
|
|
# that's about to crash on missing imports. Smoke-test feedback on
|
|
# PR #2783: nesquena/hermes-webui requested this guard.
|
|
$AgentDir = $env:HERMES_WEBUI_AGENT_DIR
|
|
if ($AgentDir -and -not (Test-Path (Join-Path $AgentDir 'hermes_cli') -PathType Container)) {
|
|
Write-Error "HERMES_WEBUI_AGENT_DIR is set to '$AgentDir' but no hermes_cli/ folder exists there. Unset the variable to fall back to auto-discovery, or fix the path."
|
|
exit 1
|
|
}
|
|
if (-not $AgentDir) {
|
|
# Build candidate list incrementally — ${env:ProgramFiles(x86)} is null on
|
|
# 32-bit Windows and in some constrained environments, and Join-Path throws
|
|
# on a null Path. Skip any system-wide root that isn't set so the launcher
|
|
# stays robust across Windows variants. USERPROFILE is always set so it
|
|
# stays unguarded; the dev-checkout sibling is path-derived, not env-based.
|
|
$candidates = @()
|
|
$candidates += (Join-Path $env:USERPROFILE '.hermes\hermes-agent')
|
|
foreach ($root in @($env:LOCALAPPDATA, ${env:ProgramW6432}, ${env:ProgramFiles}, ${env:ProgramFiles(x86)})) {
|
|
if ($root) { $candidates += (Join-Path $root 'hermes\hermes-agent') }
|
|
}
|
|
$candidates += (Join-Path (Split-Path -Parent $RepoRoot) 'hermes-agent')
|
|
# De-dup: when running in a WOW64 (32-bit-on-64-bit) PowerShell process,
|
|
# $env:ProgramFiles is redirected to C:\Program Files (x86), so without
|
|
# $env:ProgramW6432 (the canonical 64-bit override) we'd miss the real
|
|
# C:\Program Files\hermes\hermes-agent AND duplicate the x86 entry.
|
|
# Select-Object -Unique collapses any collisions regardless of cause.
|
|
$candidates = $candidates | Select-Object -Unique
|
|
foreach ($c in $candidates) {
|
|
if (Test-Path (Join-Path $c 'hermes_cli') -PathType Container) { $AgentDir = $c; break }
|
|
}
|
|
}
|
|
if (-not $AgentDir) {
|
|
$searched = $candidates -join ', '
|
|
Write-Error "hermes-agent not found. Searched: $searched. Set HERMES_WEBUI_AGENT_DIR explicitly to override."
|
|
exit 1
|
|
}
|
|
|
|
# === Prefer the agent's venv Python if available =======================
|
|
$agentVenvPython = Join-Path $AgentDir 'venv\Scripts\python.exe'
|
|
if (Test-Path $agentVenvPython) {
|
|
$Python = $agentVenvPython
|
|
}
|
|
|
|
# === Resolve bind + state defaults =====================================
|
|
$BindHostFinal = if ($BindHost) { $BindHost } elseif ($env:HERMES_WEBUI_HOST) { $env:HERMES_WEBUI_HOST } else { '127.0.0.1' }
|
|
$PortFinal = if ($Port) {
|
|
$Port
|
|
} elseif ($env:HERMES_WEBUI_PORT) {
|
|
# TryParse + range guard on the env var. A plain [int] cast on the
|
|
# env var throws InvalidCastException with no actionable context when
|
|
# the env var is set to a non-integer (typo, accidental shell
|
|
# expansion, etc.) — surface a targeted error message instead.
|
|
$parsedPort = 0
|
|
if (-not [int]::TryParse($env:HERMES_WEBUI_PORT, [ref]$parsedPort)) {
|
|
Write-Error "HERMES_WEBUI_PORT='$($env:HERMES_WEBUI_PORT)' is not a valid integer port. Unset the variable to use the default (8787), or set it to a number 1-65535."
|
|
exit 1
|
|
}
|
|
if ($parsedPort -lt 1 -or $parsedPort -gt 65535) {
|
|
Write-Error "HERMES_WEBUI_PORT=$parsedPort is out of TCP-port range. Must be 1-65535."
|
|
exit 1
|
|
}
|
|
$parsedPort
|
|
} else {
|
|
8787
|
|
}
|
|
$env:HERMES_WEBUI_HOST = $BindHostFinal
|
|
$env:HERMES_WEBUI_PORT = "$PortFinal"
|
|
if (-not $env:HERMES_WEBUI_STATE_DIR) {
|
|
$env:HERMES_WEBUI_STATE_DIR = Join-Path $env:USERPROFILE '.hermes\webui'
|
|
}
|
|
if (-not $env:HERMES_HOME) {
|
|
$env:HERMES_HOME = Join-Path $env:USERPROFILE '.hermes'
|
|
}
|
|
|
|
# === Ensure dirs exist =================================================
|
|
New-Item -ItemType Directory -Force -Path $env:HERMES_HOME | Out-Null
|
|
New-Item -ItemType Directory -Force -Path $env:HERMES_WEBUI_STATE_DIR | Out-Null
|
|
|
|
# === Launch (foreground, matches start.sh) =============================
|
|
Write-Host "[start.ps1] Hermes WebUI native Windows launcher" -ForegroundColor Cyan
|
|
Write-Host "[start.ps1] Python: $Python"
|
|
Write-Host "[start.ps1] Agent dir: $AgentDir"
|
|
Write-Host "[start.ps1] State dir: $env:HERMES_WEBUI_STATE_DIR"
|
|
Write-Host "[start.ps1] Binding: ${BindHostFinal}:${PortFinal}"
|
|
Write-Host ""
|
|
|
|
$serverPath = Join-Path $RepoRoot 'server.py'
|
|
if (-not (Test-Path $serverPath)) {
|
|
Write-Error "server.py not found at $serverPath - is this the hermes-webui repo root?"
|
|
exit 1
|
|
}
|
|
|
|
# Capture exit code, let finally{} run Pop-Location, exit AFTER the try.
|
|
# Plain `exit $LASTEXITCODE` inside the try block can prevent the finally
|
|
# from running in some termination paths (especially when dot-sourced or
|
|
# in interactive sessions), leaving the caller's working directory stuck
|
|
# at $RepoRoot.
|
|
$script:serverExitCode = 0
|
|
Push-Location $RepoRoot
|
|
try {
|
|
# @args was non-functional here — PowerShell does NOT populate $args when the
|
|
# script declares [CmdletBinding()] with an explicit param() block (Copilot's
|
|
# finding on PR #2807). Dropped rather than added a ValueFromRemainingArguments
|
|
# parameter, because the existing tracked use case is the launcher running
|
|
# server.py with the env-var-driven config — no pass-through args are needed.
|
|
# If pass-through becomes a requirement later, add a [Parameter(ValueFromRemainingArguments=$true)] [string[]]$ServerArgs and splat that.
|
|
& $Python $serverPath
|
|
$script:serverExitCode = $LASTEXITCODE
|
|
} finally {
|
|
Pop-Location
|
|
}
|
|
exit $script:serverExitCode
|