README.md

Jan - Personal AI

Getting Started - Docs - Changelog - Bug reports - Discord

⚠️ Jan is currently in Development: Expect breaking changes and bugs!

Jan is a free, open-source alternative to OpenAI that runs on your personal computer.

Jan runs on any hardware. From PCs to multi-GPU clusters, Jan supports universal architectures:

• Nvidia GPUs (fast)
• Apple M-series (fast)
• Apple Intel
• Linux Debian
• Windows x64

Download Jan at https://jan.ai/

Demo

Demo.Jan.0.3.0.mp4

Video: Jan v0.3.0 on Mac Air M2, 16GB Ventura

Quicklinks

• User Guides
• Developer docs
• API reference
• Nitro Github: Nitro is a C++ inference engine

Troubleshooting

As Jan is development mode, you might get stuck on a broken build.

To reset your installation:

1. Delete Jan from your /Applications folder

2. Delete Application data:

   # Newer versions
   rm -rf /Users/$(whoami)/Library/Application\ Support/jan
   
   # Versions 0.2.0 and older
   rm -rf /Users/$(whoami)/Library/Application\ Support/jan-electron

3. Clear Application cache:

   rm -rf /Users/$(whoami)/Library/Caches/jan*

4. Use the following commands to remove any dangling backend processes:

   ps aux | grep nitro

   Look for processes like "nitro" and "nitro_arm_64," and kill them one by one with:

   kill -9 <PID>

Contributing

Contributions are welcome! Please read the CONTRIBUTING.md file

Pre-requisites

• node >= 20.0.0
• yarn >= 1.22.0

Instructions

Note: This instruction is tested on MacOS only.

1. Clone the Repository:

   git clone https://github.com/janhq/jan
   git checkout DESIRED_BRANCH
   cd jan

2. Install dependencies:

   yarn install

   # Build core module
   yarn build:core

   # Packing base plugins
   yarn build:plugins

   # Packing uikit
   yarn build:uikit

3. Run development and Using Jan Desktop

   yarn dev
   

   This will start the development server and open the desktop app. In this step, there are a few notification about installing base plugin, just click OK and Next to continue.

For production build

# Do step 1 and 2 in previous section
git clone https://github.com/janhq/jan
cd jan
yarn install

# Build core module
yarn build:core

# Package base plugins
yarn build:plugins

# Packing uikit
yarn build:uikit

# Build the app
yarn build

This will build the app MacOS m1/m2 for production (with code signing already done) and put the result in dist folder.

Acknowledgements

Jan builds on top of other open-source projects:

• llama.cpp
• TensorRT

Contact

• Bugs & requests: file a Github ticket
• For discussion: join our Discord here
• For business inquiries: email [email protected]
• For jobs: please email [email protected]

License

Jan is free and open source, under the AGPLv3 license.