Skip to content

Commit 7bd9b6d

Browse files
Rick Valdesclaude
andcommitted
README: document the real Windows story (x64 native, ARM64 via emulation)
Reverts the WSL-required framing. Windows uses the x64 build — native on x64, under emulation on ARM64, where the TUI works. No native ARM64 build ships because it cannot start the renderer (same limitation as opencode's own). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 80341d7 commit 7bd9b6d

1 file changed

Lines changed: 11 additions & 23 deletions

File tree

README.md

Lines changed: 11 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -23,32 +23,20 @@ curl -fsSL https://raw.githubusercontent.com/utmstack/utmstack-cli/main/install
2323
curl -fsSL https://raw.githubusercontent.com/utmstack/utmstack-cli/main/install | bash
2424
```
2525

26-
### Windows — use WSL for the interactive UI
27-
28-
The **interactive terminal UI does not run on native Windows.** It needs FFI to
29-
load its terminal renderer (OpenTUI), which is not available in a Bun-compiled
30-
binary on Windows — the same reason opencode itself ships no native Windows CLI.
31-
Run it in **WSL**, where it works exactly as on Linux:
32-
33-
```powershell
34-
wsl --install # once, then open a WSL terminal
35-
```
36-
```bash
37-
# inside WSL:
38-
curl -fsSL https://raw.githubusercontent.com/utmstack/utmstack-cli/main/install | bash
39-
utmstack # full interactive TUI
40-
```
41-
42-
**Native Windows** (PowerShell) still gives you the headless command and the
43-
SIEM tools, just not the interactive UI:
26+
### Windows — x64 (and ARM64 via emulation)
4427

4528
```powershell
4629
irm https://raw.githubusercontent.com/utmstack/utmstack-cli/main/install.ps1 | iex
47-
utmstack run "..." # one-shot, works natively
4830
```
4931

50-
The UTMStack MCP server runs natively on Windows too, so its SIEM tools are
51-
available from any native MCP client (Claude Code, Cursor, …).
32+
Run this in **PowerShell**, not `cmd.exe`. The installer always installs the
33+
**x64** build. On an ARM64 machine it runs under Windows' built-in x64
34+
emulation, where the full interactive TUI works (verified on Windows 11 ARM64).
35+
36+
There is no native ARM64 build: the Bun-compiled ARM64 binary can't initialize
37+
OpenTUI's terminal renderer — a toolchain limitation that breaks opencode's own
38+
`windows-arm64` binary identically — so shipping one would just crash. The x64
39+
build under emulation is the supported ARM64 path.
5240

5341
### What gets installed
5442

@@ -74,8 +62,8 @@ Every combination below gets a prebuilt binary:
7462
| macOS 12+ | Intel (`x64`) | includes a no-AVX2 build for older Macs |
7563
| Linux (glibc 2.35+) | `x86_64` | Ubuntu 22.04+, RHEL 9+, Debian 12+ |
7664
| Linux (glibc 2.39+) | `arm64` / `aarch64` | Ubuntu 24.04+, Debian 13+, Kali rolling |
77-
| Windows 10/11 | `x64` | |
78-
| Windows 11 | `ARM64` | Surface, and Parallels VMs on Apple Silicon |
65+
| Windows 10/11 | `x64` | native |
66+
| Windows 11 | `ARM64` | via x64 emulation (no native ARM64 build) |
7967

8068
**Older or virtualised x64 CPUs**: many cloud VMs lack AVX2. The installer
8169
detects this and fetches a `-baseline` build automatically — no action needed.

0 commit comments

Comments
 (0)