Installation
Native builds for macOS, Windows, and Linux — plus building from source.
Every release publishes native builds on GitHub Releases. There is no runtime to install first: fonts are embedded in the binary, and the Linux AppImage bundles its own X11/Wayland/font libraries.
The Nermal command
Every installer ships the Nermal CLI beside the app, and the app puts it on your
PATH the first time it launches. That is what lets a script — or a coding agent
in some other terminal — open panes and read them back.
- On Unix it is a symlink into whichever of
/opt/homebrew/bin,/usr/local/bin,~/.local/bin,~/bin, or~/.cargo/binyour PATH already covers. - On Windows the install directory is appended to your user PATH, and the uninstaller removes it again.
A Nermal you installed yourself — a cargo install build, a package manager's
copy — is never replaced. To turn the whole thing off, uncheck Settings →
Agents → Install the Nermalcommand on PATH.
Inside a Nermalpane the CLI works regardless of PATH, because panes inherit the app's environment.
Updating
Nermalchecks for updates every six hours and can update itself: Settings → About → Check now, then Update and relaunch. Releases are downloaded and verified in the background so applying one is just a restart.
Pick Stable or Nightly under Settings → About → Update channel. See Updates and channels for what each feed publishes and how switching behaves.
Building from source
You need a stable Rust toolchain. The build is a plain cargo build; the app
binary is Nermal-app.
A source build does not update itself, and it will not replace an installed copy's server. If you run both, see Troubleshooting.
Uninstalling
Quit Nermal(use Quit and Stop Server from the tray menu so the background
server stops too), then drag the app to the Trash. Your settings live in
~/.config/Nermal and are left alone; delete that folder to remove them.
Use Add or remove programs. The uninstaller removes the PATH entry and
any Explorer context-menu keys it added. Settings live in
%APPDATA%\Nermal.
Delete the AppImage or the unpacked directory. Settings live in
~/.config/Nermal.