Skip to content

README.md

Latest commit

 

History

History
71 lines (55 loc) · 1.59 KB

README.md

File metadata and controls

71 lines (55 loc) · 1.59 KB

oMLX macOS App Packaging

Packages oMLX as a macOS menubar app using venvstacks.

Requirements

  • macOS 15.0+ (Sequoia) — required by MLX >= 0.29.2
  • Apple Silicon (M1/M2/M3/M4)
  • Python 3.11+
  • venvstacks: pip install venvstacks

Build

cd packaging

# Full build (venvstacks + app bundle + DMG)
python build.py

# Skip venvstacks build (use existing environment)
python build.py --skip-venv

# DMG only (use existing build)
python build.py --dmg-only

Output

packaging/
├── build/
│   ├── venvstacks/     # venvstacks build cache
│   ├── envs/           # Exported environments
│   └── oMLX.app/       # App bundle
└── dist/
    └── oMLX-<version>.dmg  # Distribution DMG

Structure

oMLX.app/
├── Contents/
│   ├── Info.plist
│   ├── MacOS/
│   │   └── oMLX           # Launcher script
│   ├── Resources/
│   │   ├── omlx_app/      # Menubar app
│   │   ├── omlx/          # oMLX server
│   │   └── AppIcon.icns
│   └── Frameworks/
│       ├── cpython3.11/   # Python runtime
│       ├── mlx-framework/ # MLX + dependencies
│       └── omlx-app/      # App layer

Layer Configuration

Layer Contents
Runtime Python 3.11
Framework MLX, mlx-lm, mlx-vlm, FastAPI, transformers
Application rumps, PyObjC

Installation

  1. Open the DMG file
  2. Drag oMLX.app to the Applications folder
  3. Launch the app (appears in the menubar)
  4. Set the model directory in Settings
  5. Click Start Server