Milady OSmilady OS

✦   install

get
milady.

Every package manager. Every platform. Pick one.

installation

install methods

one-line install

macOS · Linuxrecommended

Detects your architecture, downloads the right binary, adds it to your PATH. Fastest path to running.

bash
curl -fsSL https://get.milady.ai | bash

Homebrew

macOS · Linux

Easy updates with brew upgrade. Recommended if you're already in the Homebrew ecosystem.

bash
brew tap milady-ai/milady
brew install milady

npm

Node.js 22+

Install globally or run without installing via npx. Requires Node.js 22 or later.

bash
# global
npm install -g milady

# or without installing
npx milady

Docker

all platforms

Containerized. REST API on 2138, WebSocket on 18789, data persisted to a named volume.

bash
docker pull ghcr.io/milady-ai/milady:latest

docker run -d \
  -p 2138:2138 \
  -p 18789:18789 \
  -v milady-data:/app/data \
  ghcr.io/milady-ai/milady:latest

Flatpak

Linux

Sandboxed installation on any Flatpak-supporting Linux distribution.

bash
flatpak install flathub ai.milady.milady

Snap

Linux

Auto-updating, sandboxed. Available in the Snap store.

bash
snap install milady

getting started

quick start

01

start milady

bash
milady start

Starts the agent runtime, REST API on :2138, WebSocket gateway on :18789.

02

open the interface

bash
milady open

Opens the desktop app. Or go to http://localhost:2138 in any browser.

03

configure a provider

bash
milady config set provider ollama
# no API key needed for local models

# or for cloud:
milady config set provider claude
milady config set api-key sk-...

Use a local Ollama instance to stay entirely offline.

04

start chatting

bash
curl -X POST http://localhost:2138/api/chat \
  -H "Content-Type: application/json" \
  -d '{"message": "hello"}'

Or just open the UI and talk.

binaries

direct downloads

all releases at github.com/milady-ai/milady/releases ↗

macOS

Apple Silicon

↓
ARM64 · .dmg

macOS

Intel

↓
x86_64 · .dmg

Windows

x64

↓
.exe · NSIS

Linux

x86_64

↓
.AppImage · .deb

Android

ARM64

↓
.apk · v8+

Docker

all platforms

↓
docker pull

npm

Node.js 22+

↓
npm install

Homebrew

macOS · Linux

↓
brew install

Flatpak

Linux

↓
flatpak install

Snap

Linux

↓
snap install

Debian

Ubuntu · Debian

↓
apt · .deb

requirements

system requirements

macOS

12.0+ · Apple Silicon or Intel

Windows

10 64-bit or later

Linux

Kernel 5.4+ · glibc 2.31+

Android

Android 8.0+ (API 26)

RAM

4 GB min · 8 GB recommended

Storage

500 MB · more for local models

Node.js

v22.0.0+ (for npm install)

Docker

20.10.0+