Lychee

README

# 🧠 lychee - Run powerful artificial intelligence locally today

[![](https://img.shields.io/badge/Download_Lychee-Blue?style=for-the-badge)](https://github.com/hermionenoncyclical848/lychee)

Lychee provides a simple way to run advanced artificial intelligence models on your own computer. You do not need to send your data to outside servers. You keep full control of your information while you chat with smart models, build custom setups, or run automated agents. This software connects with tools like Ollama and HuggingFace to bring the latest technology to your desktop.

## 🛠 Prerequisites

Your computer needs a few things to run this software well. Please ensure your Windows system meets these standards:

- Windows 10 or 11 (64-bit).
- At least 8 gigabytes of memory, though 16 gigabytes works better.
- A modern processor.
- A solid-state drive with 10 gigabytes of free space.
- A graphics card helps with speed but is not strictly required.

You should also install Ollama from its official website first, as Lychee builds upon its structure to manage your models.

## 📦 Getting the Software

You can get the latest version of Lychee from our release page. Visit the link below to find the specific installer file for your Windows computer.

[Visit this page to download](https://github.com/hermionenoncyclical848/lychee)

Download the file ending in `.exe`. Save it to your Downloads folder. 

## ⚙️ Installation

1. Open your Downloads folder.
2. Double-click the file you downloaded.
3. Windows might show a warning. Click "More Info" and then "Run Anyway" if you see a blue box.
4. Follow the steps on your screen.
5. The installer places a shortcut icon on your desktop.

## 🚀 Running Lychee

Double-click the Li-chee icon on your desktop. A small window opens. This is the background controller. Do not close this window while you use the software.

Once the background controller shows that it is ready, open your web browser. Type `http://localhost:8080` into the address bar and press Enter. This opens the embedded dashboard. This dashboard is the main screen where you interact with your models.

## 🧩 Features

Lychee offers features for casual users and power users alike.

- Anthropic API: Connect your own keys to use advanced cloud models alongside your local ones.
- Model Composer: Design and save custom roles for your models. Tell your model to act like a teacher, a coder, or a writer.
- Agent Sandbox: Test automated tasks in a safe environment.
- HuggingFace Integration: Search for and download new models with a single click.
- Web Dashboard: Manage everything through your browser without touching command code.

## 🌐 Connecting Models

When you first open the dashboard, you will have no models. To add one:

1. Click the "Model Library" tab in your dashboard.
2. Search for a model name. You can use common names like 'llama3' or 'mistral'.
3. Click the "Download" button.
4. Wait for the progress bar to finish.
5. Go back to the chat screen and select your new model from the dropdown menu.

## 🛡 Security and Privacy

Everything happens on your hardware. When you type a prompt, the message stays on your computer. You do not share your history with the creators of this software or any central database. This keeps your experiments and personal notes private.

## 🔧 Troubleshooting

If the dashboard does not open:
- Check if the background command window is still open.
- Ensure Ollama is running. Look for the Ollama logo in your taskbar tray near the clock.
- Restart the Lychee application from your desktop shortcut.

If a model fails to load:
- Check your internet connection.
- Ensure you have enough disk space for the model file.
- Try selecting a smaller model if your computer runs slowly.

## 📈 Improving Performance

If you want faster responses, consider these tips:
- Close other memory-heavy programs like web browsers with many open tabs.
- Use smaller "quantized" models. These files take less space and memory.
- Use a computer with a dedicated graphics card. The software automatically uses your graphics card if one exists.
- Keep your models updated. The library tab shows when newer versions arrive. 

## 📝 Configuration

You can change basic settings in the "Settings" tab of the dashboard. You can toggle dark mode, change the port number, or modify how many messages the application remembers during a chat. Save your changes to apply them immediately. You do not need to restart the application for most settings. 

Lychee aims to provide a reliable base for your artificial intelligence needs. The system handles the complex work behind the scenes so you can focus on your projects.