Skip to content

Install Natamux

Natamux is a desktop app for macOS (Apple silicon and Intel), Windows and Linux, all on 64-bit. The macOS and Linux apps update themselves; on Windows the app tells you about a new version and you run the new installer.

  • git. Natamux makes a git worktree for each task. On Windows, install Git for Windows.
  • Windows only: Windows 10 version 1809 or later, or Windows 11, on x64. Windows on Arm may run the x64 app, but it is not tested.
  • At least one coding agent, installed and logged in: claude, codex, gemini, copilot or cursor-agent. See Agents.
  • gh (GitHub CLI), optional. Needed for opening pull requests, importing issues and CI status. Run gh auth login once.

Get the file for your system from the latest release.

Every file:

System File
macOS, Apple silicon (M1 and later) Natamux-mac-arm64.dmg
macOS, Intel Natamux-mac-x64.dmg
Windows 10 and 11, x64 Natamux-win-x64.exe
Linux, any distribution Natamux-linux-x86_64.AppImage
Debian, Ubuntu Natamux-linux-amd64.deb
Linux, no install Natamux-linux-x64.tar.gz

Not sure which Mac you have? Open Apple menu → About This Mac. Chip: Apple M… means Apple silicon; Processor: Intel means Intel. You can also build the app from source with scripts/package-desktop.sh; see packages/desktop/README.md.

  1. Open the .dmg and drag Natamux to Applications.

  2. Open Natamux. macOS blocks it the first time.

  3. Open System Settings → Privacy & Security and click Open Anyway.

  4. If there is no such button, remove the quarantine flag and open the app again:

    Terminal window
    xattr -dr com.apple.quarantine /Applications/Natamux.app

Download SHA256SUMS.txt and SHA256SUMS.txt.minisig from the same release and put them next to your file.

First check that the release key signed SHA256SUMS.txt, with minisign (brew install minisign, apt install minisign, or scoop install minisign):

Terminal window
minisign -Vm SHA256SUMS.txt -P RWSgtwsXHppEP5n4kgg1Q3yNIYODQNGsMQBKF93tjSRwzL1BrjeGoBpo

It must say Signature and comment signature verified and Trusted comment: natamux v… with the version you downloaded. Releases up to v0.1.23 have no signature.

Then check your file against SHA256SUMS.txt:

Terminal window
# macOS
shasum -a 256 -c SHA256SUMS.txt --ignore-missing
# Linux
sha256sum -c SHA256SUMS.txt --ignore-missing

On Windows, in PowerShell, compare the hash with the line for Natamux-win-x64.exe in SHA256SUMS.txt:

Terminal window
(Get-FileHash .\Natamux-win-x64.exe -Algorithm SHA256).Hash.ToLower()
Select-String Natamux-win-x64.exe .\SHA256SUMS.txt

On macOS and Linux you should see OK for the file you downloaded. On Windows the two hashes must be the same.

For contributors. Natamux is developed in a GitHub Codespace, where Docker, Node.js and pnpm are ready. In the codespace terminal:

Terminal window
scripts/dev.sh demo

Open port 5173 and sign in with the token devtoken. The demo has a task with a workspace, commits and changes. scripts/dev.sh seed makes tasks in every state with fake agents at work. See docs/dev-setup.md and docs/docker.md in the repository.

To start the desktop app from the source tree, see packages/desktop/README.md.

The production compose file runs the dashboard and the daemon in two hardened containers. It keeps tasks, stages and the dashboard, but its images contain no coding agents. See Self-host with Docker.

The desktop app puts the natamux and nmx commands in its own terminals, so agents can run natamux done and natamux ask. To use them in your own shell, add the app’s bin folder to your PATH. The app rewrites the files in it each time it starts.

The folder is bin inside the app’s user data folder:

System Folder
macOS ~/Library/Application Support/Natamux/bin
Windows %APPDATA%\Natamux\bin
Linux ~/.config/Natamux/bin

Add one line to ~/.zshrc (zsh) or ~/.bashrc (bash):

~/.zshrc
export PATH="$HOME/Library/Application Support/Natamux/bin:$PATH"

Open a new shell. The command also needs the daemon’s token and address:

Terminal window
export NATAMUX_TOKEN="$(cat "$HOME/Library/Application Support/Natamux/daemon-token")"
export NATAMUX_URL=http://127.0.0.1:4317
natamux task list

The app uses port 4317 when it is free, and another free port when it is not. Check the address in the dashboard’s browser URL or in the daemon log. See Desktop app and the CLI reference.

Quick start.