@@ -22,24 +22,28 @@ Run 50+ model families — Llama, Qwen, Gemma, DeepSeek, Mistral — natively on
2222
2323## Install
2424
25- ** Option 1: Download** (recommended)
26-
27- Go to [ Releases] ( https://github.com/nova/nova/releases ) and download the latest ` NovaMLX-vX.X.X-arm64.tar.gz ` :
25+ ** Option 1: Homebrew** (recommended)
2826
2927``` bash
30- tar -xzf NovaMLX- * .tar.gz
31- sudo mv NovaMLX /usr/local/bin/
32- sudo mv nova /usr/local/bin/
28+ brew tap cnshsliu/novamlx
29+ brew install novamlx
30+ brew services start novamlx
3331```
3432
35- ** Option 2: Build from source**
33+ ** Option 2: Download DMG**
34+
35+ Go to [ Releases] ( https://github.com/cnshsliu/novamlx/releases ) and download the latest ` NovaMLX-X.X.X-arm64.dmg ` :
36+
37+ 1 . Open the ` .dmg ` file
38+ 2 . Drag ** NovaMLX** to your ** Applications** folder
39+ 3 . Launch NovaMLX — the menu bar icon appears and the server starts on ` localhost:8080 `
40+
41+ ** Option 3: Build from source**
3642
3743``` bash
38- git clone https://github.com/nova/nova .git
39- cd nova
44+ git clone https://github.com/cnshsliu/novamlx .git
45+ cd novamlx
4046./build.sh -c release
41- sudo cp .build/release/NovaMLX /usr/local/bin/
42- sudo cp .build/release/nova /usr/local/bin/
4347```
4448
4549> Requires macOS 15 (Sequoia), Apple Silicon, and Xcode 16+.
@@ -50,25 +54,31 @@ sudo cp .build/release/nova /usr/local/bin/
5054
5155### 1. Start the server
5256
53- ``` bash
54- NovaMLX
55- ```
57+ Launch ** NovaMLX** from your Applications folder (or Spotlight).
5658
5759A ** menu bar icon** appears. The server runs on ` localhost:8080 ` .
5860
59- ### 2. Download a model
61+ ### 2. (Optional) Add ` nova ` CLI to your PATH
62+
63+ The ` nova ` CLI is bundled inside the app. Symlink it for easy access:
64+
65+ ``` bash
66+ sudo ln -s /Applications/NovaMLX.app/Contents/MacOS/nova /usr/local/bin/nova
67+ ```
68+
69+ ### 3. Download a model
6070
6171``` bash
6272nova download mlx-community/Meta-Llama-3.1-8B-Instruct-4bit
6373```
6474
65- ### 3 . Load it
75+ ### 4 . Load it
6676
6777``` bash
6878nova load mlx-community/Meta-Llama-3.1-8B-Instruct-4bit
6979```
7080
71- ### 4 . Use it
81+ ### 5 . Use it
7282
7383``` bash
7484# Interactive chat
@@ -125,10 +135,10 @@ Add to your opencode config (`~/.config/opencode/config.json`):
125135
126136Settings → Models → OpenAI API Compatible:
127137
128- | Field | Value |
129- | -------| -------|
130- | Base URL | ` http://localhost:8080/v1 ` |
131- | API Key | ` unused ` |
138+ | Field | Value |
139+ | -------- | ----------------------------------------------- |
140+ | Base URL | ` http://localhost:8080/v1 ` |
141+ | API Key | ` unused ` |
132142| Model ID | ` mlx-community/Meta-Llama-3.1-8B-Instruct-4bit ` |
133143
134144### Continue.dev
@@ -137,13 +147,15 @@ Add to `~/.continue/config.json`:
137147
138148``` json
139149{
140- "models" : [{
141- "title" : " NovaMLX Local" ,
142- "provider" : " openai" ,
143- "apiBase" : " http://localhost:8080/v1" ,
144- "apiKey" : " unused" ,
145- "model" : " mlx-community/Meta-Llama-3.1-8B-Instruct-4bit"
146- }]
150+ "models" : [
151+ {
152+ "title" : " NovaMLX Local" ,
153+ "provider" : " openai" ,
154+ "apiBase" : " http://localhost:8080/v1" ,
155+ "apiKey" : " unused" ,
156+ "model" : " mlx-community/Meta-Llama-3.1-8B-Instruct-4bit"
157+ }
158+ ]
147159}
148160```
149161
@@ -276,6 +288,7 @@ nova bench status # Check benchmark progress
276288### macOS Menu Bar App
277289
278290When you start ` NovaMLX ` , a menu bar icon appears showing:
291+
279292- Server status (running/stopped)
280293- Loaded models
281294- GPU memory usage
@@ -375,28 +388,28 @@ curl http://localhost:8080/v1/audio/speech \
375388
376389Same server, both APIs:
377390
378- | API | Endpoint |
379- | -----| ----------|
380- | OpenAI Chat | ` POST /v1/chat/completions ` |
381- | OpenAI Completions | ` POST /v1/completions ` |
382- | OpenAI Responses | ` POST /v1/responses ` |
383- | OpenAI Embeddings | ` POST /v1/embeddings ` |
384- | Anthropic Messages | ` POST /v1/messages ` |
391+ | API | Endpoint |
392+ | ------------------ | --------------------------- |
393+ | OpenAI Chat | ` POST /v1/chat/completions ` |
394+ | OpenAI Completions | ` POST /v1/completions ` |
395+ | OpenAI Responses | ` POST /v1/responses ` |
396+ | OpenAI Embeddings | ` POST /v1/embeddings ` |
397+ | Anthropic Messages | ` POST /v1/messages ` |
385398
386399---
387400
388401## Supported Models
389402
390403Any SafeTensors model from HuggingFace in 4-bit, 8-bit, or FP16. Popular choices:
391404
392- | Model | Size | Download Command |
393- | -------| ------| -----------------|
394- | Llama 3.1 8B | ~ 4.5 GB | ` nova download mlx-community/Meta-Llama-3.1-8B-Instruct-4bit ` |
395- | Qwen 2.5 7B | ~ 4.5 GB | ` nova download mlx-community/Qwen2.5-7B-Instruct-4bit ` |
396- | Gemma 2 9B | ~ 5.5 GB | ` nova download mlx-community/gemma-2-9b-it-4bit ` |
397- | Phi 3.5 Mini | ~ 2 GB | ` nova download mlx-community/Phi-3.5-mini-instruct-4bit ` |
398- | Mistral 7B | ~ 4 GB | ` nova download mlx-community/Mistral-7B-Instruct-v0.3-4bit ` |
399- | Qwen 2.5 VL 7B | ~ 4.5 GB | ` nova download mlx-community/Qwen2.5-VL-7B-Instruct-4bit ` |
405+ | Model | Size | Download Command |
406+ | -------------- | ------- | ------------------------------------------------------------- |
407+ | Llama 3.1 8B | ~ 4.5 GB | ` nova download mlx-community/Meta-Llama-3.1-8B-Instruct-4bit ` |
408+ | Qwen 2.5 7B | ~ 4.5 GB | ` nova download mlx-community/Qwen2.5-7B-Instruct-4bit ` |
409+ | Gemma 2 9B | ~ 5.5 GB | ` nova download mlx-community/gemma-2-9b-it-4bit ` |
410+ | Phi 3.5 Mini | ~ 2 GB | ` nova download mlx-community/Phi-3.5-mini-instruct-4bit ` |
411+ | Mistral 7B | ~ 4 GB | ` nova download mlx-community/Mistral-7B-Instruct-v0.3-4bit ` |
412+ | Qwen 2.5 VL 7B | ~ 4.5 GB | ` nova download mlx-community/Qwen2.5-VL-7B-Instruct-4bit ` |
400413
401414Search for more: ` nova search "your model name" `
402415
@@ -421,7 +434,7 @@ curl -X PUT http://localhost:8081/admin/models/my-model/settings \
421434
422435### Config File
423436
424- ` ~/Library/Application Support/NovaMLX /config.json ` :
437+ ` ~/.config/opencode /config.json ` :
425438
426439``` json
427440{
@@ -445,6 +458,7 @@ curl -X PUT http://localhost:8081/admin/models/my-model/settings \
445458## For Developers
446459
447460See [ DEVELOPMENT.md] ( DEVELOPMENT.md ) for:
461+
448462- Architecture overview (11-module design)
449463- Building from source
450464- Running tests
0 commit comments