Installation

Installation

English · 中文

Download and run WispTerm on Windows or macOS, or build it from source.

WispTerm ships for Windows and macOS. The Linux port is still in progress (see TODO.md).

Windows

1. Download the latest Windows release from GitHub Releases.
2. Unzip it and run wispterm.exe.

WispTerm does not elevate shells on its own — a normally launched window gives you a standard token. To run an elevated shell, right-click wispterm.exe and choose Run as administrator (see FAQ).

Portable profile (Windows only): put a file named wispterm.conf next to wispterm.exe and WispTerm uses it as the config, so the whole setup is self-contained on a USB stick or shared folder.

macOS

Requires macOS 13+. Download the .app for your CPU (Apple Silicon or Intel) and move it to /Applications.

• Launch WispTerm.app normally, or
• Run the binary directly to pass CLI flags:

  WispTerm.app/Contents/MacOS/wispterm --version

Passing command-line options requires the binary path — double-clicking the .app cannot take flags.

Build from source

Requires Zig 0.15.2.

Windows (PowerShell):

zig build                         # Debug build for development
zig build -Doptimize=ReleaseFast  # ReleaseFast build for distribution

macOS:

zig build macos-app -Dtarget=aarch64-macos   # Apple Silicon (use x86_64-macos on Intel)
open zig-out/bin/WispTerm.app

For full build, packaging, and release details see docs/development.md.

Verify the install

wispterm --version            # print the WispTerm version
wispterm --show-config-path   # print the resolved config path

Next: Getting-Started.

---

See also: Getting-Started · Configuration