diff --git a/JanBanner.png b/JanBanner.png new file mode 100644 index 0000000000..1658318714 Binary files /dev/null and b/JanBanner.png differ diff --git a/README.md b/README.md index 29434dac43..0439605378 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# Jan - Turn your computer into an AI computer +# Jan - Local AI Assistant -![Jan banner](https://github.com/janhq/jan/assets/89722390/35daac7d-b895-487c-a6ac-6663daaad78e) +![Jan banner](./JanBanner.png)

@@ -12,18 +12,22 @@

- Getting Started + Getting Started - Docs - Changelog - Bug reports - Discord

-> [!Warning] >**Jan is currently in Development**: Expect breaking changes and bugs! +

+⚠️ 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: +Jan is a ChatGPT-alternative that runs 100% offline on your device. Our goal is to make it easy for a layperson to download and run LLMs and use AI with **full control** and **privacy**. + +Jan is powered by [Cortex](https://github.com/janhq/cortex.cpp), our embeddable local AI engine that runs on any hardware. +From PCs to multi-GPU clusters, Jan & Cortex supports universal architectures: - [x] NVIDIA GPUs (fast) - [x] Apple M-series (fast) @@ -31,6 +35,12 @@ Jan is an open-source ChatGPT alternative that runs 100% offline on your compute - [x] Linux Debian - [x] Windows x64 +#### Features: +- [Model Library](https://jan.ai/docs/models/manage-models#add-models) with popular LLMs like Llama, Gemma, Mistral, or Qwen +- Connect to [Remote AI APIs](https://jan.ai/docs/remote-models/openai) like Groq and OpenRouter +- Local API Server with OpenAI-equivalent API +- [Extensions](https://jan.ai/docs/extensions) for customizing Jan + ## Download @@ -141,79 +151,64 @@ Jan is an open-source ChatGPT alternative that runs 100% offline on your compute
-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. +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) +https://github.com/user-attachments/assets/c3592fa2-c504-4d9d-a885-7e00122a50f3 -_Realtime Video: Jan v0.4.3-nightly on a Mac M1, 16GB Sonoma 14_ +*Real-time Video: Jan v0.5.7 on a Mac M2, 16GB Sonoma 14.2* ## Quicklinks -#### Jan +### Jan -- [Jan website](https://jan.ai/) +- [Jan Website](https://jan.ai/) - [Jan GitHub](https://github.com/janhq/jan) -- [User Guides](https://jan.ai/guides/) -- [Developer docs](https://jan.ai/developer/) -- [API reference](https://jan.ai/api-reference/) -- [Specs](https://jan.ai/docs/) +- [Documentation](https://jan.ai/docs) +- [Jan Changelog](https://jan.ai/changelog) +- [Jan Blog](https://jan.ai/blog) -#### 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 +### Cortex.cpp +Jan is powered by **Cortex.cpp**. It is a C++ command-line interface (CLI) designed as an alternative to [Ollama](https://ollama.com/). By default, it runs on the llama.cpp engine but also supports other engines, including ONNX and TensorRT-LLM, making it a multi-engine platform. -As Jan is in development mode, you might get stuck on a broken build. - -To reset your installation: - -1. 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 - ``` - -2. **Remove Jan from your Applications folder and Cache folder** - - ```bash - make clean - ``` - - This will remove all build artifacts and cached files: - - - Delete Jan extension from your `~/jan/extensions` folder - - Delete all `node_modules` in current folder - - Clear Application cache in `~/Library/Caches/jan` +- [Cortex Website](https://cortex.so/) +- [Cortex GitHub](https://github.com/janhq/cortex.cpp) +- [Documentation](https://cortex.so/docs/) +- [Models Library](https://cortex.so/models) +- API Reference: *Under development* + ## Requirements for running Jan -- MacOS: 13 or higher -- Windows: +- **MacOS**: 13 or higher +- **Windows**: - Windows 10 or higher - To enable GPU support: - Nvidia GPU with CUDA Toolkit 11.7 or higher - Nvidia driver 470.63.01 or higher -- Linux: +- **Linux**: - glibc 2.27 or higher (check with `ldd --version`) - gcc 11, g++ 11, cpp 11 or higher, refer to this [link](https://jan.ai/guides/troubleshooting/gpu-not-used/#specific-requirements-for-linux) for more information - To enable GPU support: - Nvidia GPU with CUDA Toolkit 11.7 or higher - Nvidia driver 470.63.01 or higher +## Troubleshooting + +As Jan is in development mode, you might get stuck on a some common issues: +- [Troubleshooting a broken build](https://jan.ai/docs/troubleshooting#broken-build) +- [Troubleshooting NVIDIA GPU](https://jan.ai/docs/troubleshooting#troubleshooting-nvidia-gpu) +- [Troubleshooting Something's Amiss](https://jan.ai/docs/troubleshooting#somethings-amiss) + + +If you can't find what you need in our troubleshooting guide, feel free reach out to us for extra help: +1. Copy your [error logs & device specifications](https://jan.ai/docs/troubleshooting#how-to-get-error-logs). +2. Go to our [Discord](https://discord.com/invite/FTk2MvZwJH) & send it to **#🆘|get-help** channel for further support. + +*Check the logs to ensure the information is what you intend to send. Note that we retain your logs for only 24 hours, so report any issues promptly.* + + ## Contributing Contributions are welcome! Please read the [CONTRIBUTING.md](CONTRIBUTING.md) file @@ -242,11 +237,7 @@ Contributions are welcome! Please read the [CONTRIBUTING.md](CONTRIBUTING.md) fi This will start the development server and open the desktop app. -3. (Optional) **Run the API server without frontend** - ```bash - yarn dev:server - ``` ### For production build @@ -271,18 +262,18 @@ Jan builds on top of other open-source projects: - Bugs & requests: file a GitHub ticket - For discussion: join our Discord [here](https://discord.gg/FTk2MvZwJH) -- For business inquiries: email hello@jan.ai +- For business inquiries: email hello@jan.ai - For jobs: please email hr@jan.ai ## Trust & Safety -Beware of scams. +Beware of scams! -- We will never ask you for personal info -- We are a free product; there's no paid version -- We don't have a token or ICO -- We are not actively fundraising or seeking donations +- We will never request your personal information. +- Our product is completely free; no paid version exists. +- We do not have a token or ICO. +- We are a [bootstrapped company](https://en.wikipedia.org/wiki/Bootstrapping), and don't have any external investors (*yet*). We're open to exploring opportunities with strategic partners want to tackle [our mission](https://jan.ai/about#mission) together. ## License -Jan is free and open source, under the AGPLv3 license. +Jan is free and open source, under the **AGPLv3** license.