Chat MLX

Abstract

1. Introduction

ChatMLX is a modern, open-source, high-performance chat application for MacOS based on large language models, based on the powerful performance of MLX and Apple silicon. It supports multiple models, providing users with a rich variety of conversation options. It runs LLM locally to ensure user privacy and security. Report Bug · Request Feature · Download

[![Contributors][contributors-shield]][contributors-url] [![Forks][forks-shield]][forks-url] [![Stargazers][stars-shield]][stars-url] [![Issues][issues-shield]][issues-url] [![Apache License][license-shield]][license-url]

2. Objective

🤖✨ChatMLX is a modern, open-source, high-performance chat application for MacOS based on large language models.

This project demonstrates how Swift can be applied to a real-world Full Stack Web Development problem.

3. Key Features / Modules

• Multilingual: Supports all 39 major App Store languages, including English, Simplified Chinese, Traditional Chinese, Japanese, and Korean.
• Multiple Models: Provides multiple models, including Llama, OpenELM, Phi, Qwen, Starcoder, Cohere, Gemma.
• High Performance: Based on the powerful performance of MLX and Apple silicon.
• Privacy and Security: Run LLM locally to ensure user privacy and security.
• Open Source: Open source, welcome to contribute.

4. Technology Stack

5. System Requirements

General requirements for this technology stack — check the README for exact versions.

• Xcode on macOS
• Git (to clone the repository)

6. Installation & Setup

git clone https://github.com/johnmai-dev/ChatMLX.git
cd ChatMLX

xattr -cr /Applications/ChatMLX.app

option -r not recognized

usage: xattr [-slz] file [file ...]
       xattr -p [-slz] attr_name file [file ...]
       xattr -w [-sz] attr_name attr_value file [file ...]
       xattr -d [-s] attr_name file [file ...]
       xattr -c [-s] file [file ...]

The first form lists the names of all xattrs on the given file(s).
The second form (-p) prints the value of the xattr attr_name.
The third form (-w) sets the value of the xattr attr_name to attr_value.
The fourth form (-d) deletes the xattr attr_name.
The fifth form (-c) deletes (clears) all xattrs.

options:
  -h: print this help
  -s: act on symbolic links themselves rather than their targets
  -l: print long format (attr_name: attr_value)
  -z: compress or decompress (if compressed) attribute value in zip format

xattr -c /Applications/ChatMLX.app/*

sudo xattr -d com.apple.quarantine /Applications/ChatMLX.app/

Full setup instructions are in the project README.

7. Future Enhancements

Suggested extensions you can add to make this your own project.

• Add role-based access control
• Deploy on a VPS or cPanel hosting with a custom domain
• Add automated tests and a CI pipeline

8. Viva / Review Questions

Common questions examiners ask for projects in this domain.

1. Explain the frontend, backend and database layers of this application.
2. How is user authentication and authorisation implemented?
3. Describe the main database tables / collections and their relationships.
4. Which REST APIs or routes are exposed and what do they return?
5. How would you deploy this application to production?

9. Source Code & License

This project is developed by johnmai-dev and published on GitHub under the Apache License 2.0. Please follow the license terms and credit the original author when you use or modify this code.