Installation

Install a prebuilt binary, install with Go, or build ModelMux from source.

Prebuilt binaries

GitHub Releases provides archives for common Linux, macOS, and Windows targets. Download the archive matching your operating system and CPU architecture.

Platform	Release asset
Linux x86_64	`modelmux_linux_amd64.tar.gz`
Linux arm64	`modelmux_linux_arm64.tar.gz`
macOS Intel	`modelmux_darwin_amd64.tar.gz`
macOS Apple Silicon	`modelmux_darwin_arm64.tar.gz`
Windows x86_64	`modelmux_windows_amd64.zip`
Windows arm64	`modelmux_windows_arm64.zip`

Linux x86_64

curl -L -o modelmux.tar.gz \
  https://github.com/livingdolls/yute-modelmux/releases/latest/download/modelmux_linux_amd64.tar.gz

tar -xzf modelmux.tar.gz
sudo install modelmux_linux_amd64/modelmux /usr/local/bin/modelmux

Release archives include platform-specific binaries. Checksums are published with each release in checksums.txt.

Install with Go

Go 1.25 or newer is required when installing directly from source with the Go toolchain.

Terminal

go install github.com/livingdolls/yute-modelmux/cmd/modelmux@latest

The binary is normally written to $(go env GOPATH)/bin. Make sure that directory is included in your PATH.

Shell profile

export PATH="$(go env GOPATH)/bin:$PATH"

Build from source

Terminal

git clone https://github.com/livingdolls/yute-modelmux.git
cd yute-modelmux
make build
./bin/modelmux --help

Building from source is useful when testing unreleased changes or contributing to the project. Release binaries are built with CGO_ENABLED=0 for portability.

Verify the installation

Terminal

modelmux version
modelmux --help

The version command prints the release version, commit, and build timestamp. A source installation may report development values when build-time metadata was not injected.

Default paths

Purpose	Default path
Configuration	`~/.config/modelmux/config.yaml`
SQLite database	`~/.local/share/modelmux/modelmux.db`
Encrypted secret store	`~/.local/share/modelmux/secrets.enc`

The database and secret store directories are created when the related features are used.

Upgrade and remove

To upgrade a Go installation, run the same go install ...@latest command again. For a prebuilt installation, replace the existing binary with the binary from the newer release.

Before upgrading production systems, keep a copy of the current binary and back up persistent state. To remove ModelMux, delete the binary. Remove the config and data directories only when their contents are no longer needed.