ContextQMD
Back to Jan

Jan - Open-source ChatGPT replacement

README.md

0.7.95.5 KB
Original Source

Jan - Open-source ChatGPT replacement

<p align="center"> <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> </p> <p align="center"> <a href="https://jan.ai/docs/desktop">Getting Started</a> - <a href="https://discord.gg/Exe46xPMbK">Community</a> - <a href="https://jan.ai/changelog">Changelog</a> - <a href="https://github.com/janhq/jan/issues">Bug reports</a> </p>

Jan is bringing the best of open-source AI in an easy-to-use product. Download and run LLMs with full control and privacy.

Installation

<p align="center"> <table> <tr> <!-- Microsoft Store Badge --> <td align="center" valign="middle"> <a href="https://apps.microsoft.com/detail/xpdcnfn5cpzlqb"> 
    </a>
  </td>
  <!-- Spacer -->
  <td width="20"></td>
  <!-- Flathub Official Badge -->
  <td align="center" valign="middle">
    <a href="https://flathub.org/apps/ai.jan.Jan">
      
    </a>
  </td>
</tr>
</table> </p>

The easiest way to get started is by downloading one of the following versions for your respective operating system:

<table> <tr> <td><b>Platform</b></td> <td><b>Download</b></td> </tr> <tr> <td><b>Windows</b></td> <td><a href='https://app.jan.ai/download/latest/win-x64'>jan.exe</a></td> </tr> <tr> <td><b>macOS</b></td> <td><a href='https://app.jan.ai/download/latest/mac-universal'>jan.dmg</a></td> </tr> <tr> <td><b>Linux (deb)</b></td> <td><a href='https://app.jan.ai/download/latest/linux-amd64-deb'>jan.deb</a></td> </tr> <tr> <td><b>Linux (AppImage)</b></td> <td><a href='https://app.jan.ai/download/latest/linux-amd64-appimage'>jan.AppImage</a></td> </tr> <tr> <td><b>Linux (Arm64)</b></td> <td><a href='https://github.com/janhq/jan/issues/4543#issuecomment-3734911349'>How-to</a></td> </tr> </table>

Download from jan.ai or GitHub Releases.

Features

  • Local AI Models: Download and run LLMs (Llama, Gemma, Qwen, GPT-oss etc.) from HuggingFace
  • Cloud Integration: Connect to GPT models via OpenAI, Claude models via Anthropic, Mistral, Groq, MiniMax, and others
  • Custom Assistants: Create specialized AI assistants for your tasks
  • OpenAI-Compatible API: Local server at localhost:1337 for other applications
  • Model Context Protocol: MCP integration for agentic capabilities
  • Privacy First: Everything runs locally when you want it to

Build from Source

For those who enjoy the scenic route:

Prerequisites

  • Node.js ≥ 20.0.0
  • Yarn ≥ 4.5.3
  • Make ≥ 3.81
  • Rust (for Tauri)
  • (macOS Apple Silicon only) MetalToolchain xcodebuild -downloadComponent MetalToolchain

Run with Make

bash
git clone https://github.com/janhq/jan
cd jan
make dev

This handles everything: installs dependencies, builds core components, and launches the app.

Available make targets:

  • make dev - Full development setup and launch
  • make build - Production build
  • make test - Run tests and linting
  • make clean - Delete everything and start fresh

Manual Commands

bash
yarn install
yarn build:tauri:plugin:api
yarn build:core
yarn build:extensions
yarn dev

System Requirements

Minimum specs for a decent experience:

  • macOS: 13.6+ (8GB RAM for 3B models, 16GB for 7B, 32GB for 13B)
  • Windows: 10+ with GPU support for NVIDIA/AMD/Intel Arc
  • Linux: Most distributions work, GPU acceleration available

For detailed compatibility, check our installation guides.

Troubleshooting

If things go sideways:

  1. Check our troubleshooting docs
  2. Copy your error logs and system specs
  3. Ask for help in our Discord #🆘|jan-help channel

Contributing

Contributions welcome. See CONTRIBUTING.md for the full spiel.

Contact

License

Apache 2.0 - Because sharing is caring.

Acknowledgements

Built on the shoulders of giants: