# Jan - Bring AI to your Desktop ![Jan banner](https://github.com/janhq/jan/assets/89722390/35daac7d-b895-487c-a6ac-6663daaad78e)

GitHub commit activity Github Last Commit Github Contributors GitHub closed issues Discord

Getting Started - Docs - Changelog - Bug reports - Discord

> ⚠️ **Jan is currently in Development**: Expect breaking changes and bugs! Jan is an open-source ChatGPT alternative that runs 100% offline on your computer. **Jan runs on any hardware.** From PCs to multi-GPU clusters, Jan supports universal architectures: - [x] Nvidia GPUs (fast) - [x] Apple M-series (fast) - [x] Apple Intel - [x] Linux Debian - [x] Windows x64 ## Download
Version Type Windows MacOS Linux
Stable (Recommended) jan.exe Intel M1/M2 jan.deb
Experimental (Nighlty Build) Github action artifactory
Download the latest version of Jan at https://jan.ai/ or visit the **[GitHub Releases](https://github.com/janhq/jan/releases)** to download any previous release. ## Demo ![Demo](/demo.gif) _Realtime Video: Jan v0.4.3-nightly on a Mac M1, 16GB Sonoma 14_ ## Quicklinks #### Jan - [Jan website](https://jan.ai/) - [Jan Github](https://github.com/janhq/jan) - [User Guides](https://jan.ai/docs) - [Developer docs](https://jan.ai/docs/extensions/) - [API reference](https://jan.ai/api-reference/) - [Specs](https://jan.ai/specs/) #### Nitro Nitro is a high-efficiency C++ inference engine for edge computing. It is lightweight and embeddable, and can be used on its own within your own projects. - [Nitro Website](https://nitro.jan.ai) - [Nitro Github](https://github.com/janhq/nitro) - [Documentation](https://nitro.jan.ai/docs) - [API Reference](https://nitro.jan.ai/api-reference) ## Troubleshooting As Jan is in development mode, you might get stuck on a broken build. To reset your installation: 1. **Remove Jan from your Applications folder and Cache folder** ```bash make clean ``` This will remove all build artifacts and cached files: - Delete Jan from your `/Applications` folder - Clear Application cache in `/Users/$(whoami)/Library/Caches/jan` 2. Use the following commands to remove any dangling backend processes: ```sh ps aux | grep nitro ``` Look for processes like "nitro" and "nitro_arm_64," and kill them one by one with: ```sh kill -9 ``` ## Contributing Contributions are welcome! Please read the [CONTRIBUTING.md](CONTRIBUTING.md) file ### Pre-requisites - node >= 20.0.0 - yarn >= 1.22.0 - make >= 3.81 ### Instructions 1. **Clone the Repository:** ```bash git clone https://github.com/janhq/jan git checkout DESIRED_BRANCH cd jan ``` 2. **Run development and Using Jan Desktop** ``` make dev ``` This will start the development server and open the desktop app. ### For production build ```bash # Do step 1 and 2 in previous section git clone https://github.com/janhq/jan cd jan # Build the app make build ``` This will build the app MacOS m1/m2 for production (with code signing already done) and put the result in `dist` folder. ## Nightly Build Our nightly build process for this project is defined in [`.github/workflows/jan-electron-build-nightly.yml`](.github/workflows/jan-electron-build-nightly.yml) The nightly build is triggered at 2:00 AM UTC every day. Getting on Nightly: 1. Join our Discord server [here](https://discord.gg/FTk2MvZwJH) and go to channel [github-jan](https://discordapp.com/channels/1107178041848909847/1148534730359308298). 2. Download the build artifacts from the channel. 3. Subsequently, to get the latest nightly, just quit and restart the app. 4. Upon app restart, you will be automatically prompted to update to the latest nightly build. ## Manual Build Stable releases are triggered by manual builds. This is usually done for new features or a bug fixes. The process for this project is defined in [`.github/workflows/jan-electron-build-nightly.yml`](.github/workflows/jan-electron-build-nightly.yml) ## Acknowledgements Jan builds on top of other open-source projects: - [llama.cpp](https://github.com/ggerganov/llama.cpp) - [TensorRT](https://github.com/NVIDIA/TensorRT) ## Contact - Bugs & requests: file a Github ticket - For discussion: join our Discord [here](https://discord.gg/FTk2MvZwJH) - For business inquiries: email hello@jan.ai - For jobs: please email hr@jan.ai ## License Jan is free and open source, under the AGPLv3 license.