147 lines
4.5 KiB
Markdown
147 lines
4.5 KiB
Markdown
# Jan - Open-source ChatGPT replacement
|
|
|
|
<img width="2048" height="280" alt="github jan banner" src="https://github.com/user-attachments/assets/f3f87889-c133-433b-b250-236218150d3f" />
|
|
|
|
<p align="center">
|
|
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
|
|
<img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/janhq/jan"/>
|
|
<img alt="Github Last Commit" src="https://img.shields.io/github/last-commit/janhq/jan"/>
|
|
<img alt="Github Contributors" src="https://img.shields.io/github/contributors/janhq/jan"/>
|
|
<img alt="GitHub closed issues" src="https://img.shields.io/github/issues-closed/janhq/jan"/>
|
|
<img alt="Discord" src="https://img.shields.io/discord/1107178041848909847?label=discord"/>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://www.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
|
|
|
|
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>
|
|
</table>
|
|
|
|
|
|
Download from [jan.ai](https://jan.ai/) or [GitHub Releases](https://github.com/janhq/jan/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, 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 ≥ 1.22.0
|
|
- Make ≥ 3.81
|
|
- Rust (for Tauri)
|
|
|
|
### 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](https://jan.ai/docs/desktop/mac).
|
|
|
|
## Troubleshooting
|
|
|
|
If things go sideways:
|
|
|
|
1. Check our [troubleshooting docs](https://jan.ai/docs/troubleshooting)
|
|
2. Copy your error logs and system specs
|
|
3. Ask for help in our [Discord](https://discord.gg/FTk2MvZwJH) `#🆘|jan-help` channel
|
|
|
|
|
|
## Contributing
|
|
|
|
Contributions welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for the full spiel.
|
|
|
|
## Links
|
|
|
|
- [Documentation](https://jan.ai/docs) - The manual you should read
|
|
- [API Reference](https://jan.ai/api-reference) - For the technically inclined
|
|
- [Changelog](https://jan.ai/changelog) - What we broke and fixed
|
|
- [Discord](https://discord.gg/FTk2MvZwJH) - Where the community lives
|
|
|
|
## Contact
|
|
|
|
- **Bugs**: [GitHub Issues](https://github.com/janhq/jan/issues)
|
|
- **Business**: hello@jan.ai
|
|
- **Jobs**: hr@jan.ai
|
|
- **General Discussion**: [Discord](https://discord.gg/FTk2MvZwJH)
|
|
|
|
## License
|
|
|
|
Apache 2.0 - Because sharing is caring.
|
|
|
|
## Acknowledgements
|
|
|
|
Built on the shoulders of giants:
|
|
|
|
- [Llama.cpp](https://github.com/ggerganov/llama.cpp)
|
|
- [Tauri](https://tauri.app/)
|
|
- [Scalar](https://github.com/scalar/scalar)
|