chore(README): update (#133)
* chore(README): update Signed-off-by: mudler <mudler@localai.io> * Update logos --------- Signed-off-by: mudler <mudler@localai.io>
130
README.md
@@ -1,84 +1,100 @@
|
|||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="https://github.com/user-attachments/assets/6958ffb3-31cf-441e-b99d-ce34ec6fc88f" alt="LocalAgent Logo" width="220"/>
|
<img src="https://github.com/user-attachments/assets/6958ffb3-31cf-441e-b99d-ce34ec6fc88f" alt="LocalAGI Logo" width="220"/>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<h1 align="center">LOCAL AGENT</h1>
|
<h1 align="center">LocalAGI</h1>
|
||||||
<h3 align="center"><em>AI that stays where it belongs — on your machine.</em></h3>
|
<h3 align="center"><em>Your AI. Your Hardware. Your Rules.</em></h3>
|
||||||
|
|
||||||
<div align="center">
|
<div align="center">
|
||||||
|
|
||||||
[](https://goreportcard.com/report/github.com/mudler/LocalAgent)
|
[](https://goreportcard.com/report/github.com/mudler/LocalAGI)
|
||||||
[](https://opensource.org/licenses/MIT)
|
[](https://opensource.org/licenses/MIT)
|
||||||
[](https://github.com/mudler/LocalAgent/stargazers)
|
[](https://github.com/mudler/LocalAGI/stargazers)
|
||||||
[](https://github.com/mudler/LocalAgent/issues)
|
[](https://github.com/mudler/LocalAGI/issues)
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
## TAKE BACK CONTROL
|
## 🚀 What is LocalAGI?
|
||||||
|
|
||||||
**LocalAgent** is an AI platform that runs 100% on your hardware. No clouds. No data sharing. No compromises.
|
**LocalAGI** is a powerful, self-hostable AI Agent platform designed for maximum privacy and flexibility. A complete drop-in replacement for OpenAI's Responses APIs—with advanced agentic capabilities. No clouds. No data leaks. Just pure local AI that respects your privacy.
|
||||||
|
|
||||||
Built for those who value privacy as non-negotiable, LocalAgent lets you deploy intelligent agents that never phone home. Your data stays where you put it — period. Are you tired of agent wrappers to cloud APIs? me too.
|
## 🛡️ Take Back Your Privacy
|
||||||
|
|
||||||
## WHY LOCALAGENT?
|
Are you tired of AI wrappers calling out to cloud APIs, risking your privacy? So were we.
|
||||||
|
|
||||||
- **✓ TRUE PRIVACY** — Everything runs on your hardware, nothing leaves your machine
|
LocalAGI ensures your data stays exactly where you want it—on your hardware. No API keys, no cloud subscriptions, no compromise.
|
||||||
- **✓ MODEL FREEDOM** — Works with local LLM formats (GGUF, GGML) you already have
|
|
||||||
- **✓ BUILD YOUR WAY** — Extensible architecture for custom agents with specialized skills
|
|
||||||
- **✓ SLICK INTERFACE** — Clean web UI for hassle-free agent interactions
|
|
||||||
- **✓ DEV-FRIENDLY** — Comprehensive REST API for seamless integration
|
|
||||||
- **✓ PLAYS WELL WITH OTHERS** — Optimized for [LocalAI](https://github.com/mudler/LocalAI)
|
|
||||||
- **✓ RUN ANYWHERE** — Linux, macOS, Windows — we've got you covered
|
|
||||||
|
|
||||||
## THE LOCAL ECOSYSTEM
|
## 🌟 Key Features
|
||||||
|
|
||||||
LocalAgent is part of a trinity of tools designed to keep AI under your control:
|
- 🎛 **No-Code Agents**: Easy-to-configure multiple agents via Web UI.
|
||||||
|
- 🖥 **Web-Based Interface**: Simple and intuitive agent management.
|
||||||
|
- 🤖 **Advanced Agent Teaming**: Instantly create cooperative agent teams from a single prompt.
|
||||||
|
- 📡 **Connectors Galore**: Built-in integrations with Discord, Slack, Telegram, GitHub Issues, and IRC.
|
||||||
|
- 🛠 **Comprehensive REST API**: Seamless integration into your workflows. Every agent created will support OpenAI Responses API out of the box.
|
||||||
|
- 📚 **Short & Long-Term Memory**: Powered by [LocalRAG](https://github.com/mudler/LocalRAG).
|
||||||
|
- 🧠 **Planning & Reasoning**: Agents intelligently plan, reason, and adapt.
|
||||||
|
- 🖼 **Multimodal Support**: Ready for vision, text, and more.
|
||||||
|
- 🔧 **Extensible Custom Actions**: Easily script dynamic agent behaviors in Go (interpreted, no compilation!).
|
||||||
|
- 🛠 **Fully Customizable Models**: Use your own models or integrate seamlessly with [LocalAI](https://github.com/mudler/LocalAI).
|
||||||
|
|
||||||
- [**LocalAI**](https://github.com/mudler/LocalAI) — Run LLMs on your hardware
|
## 🛠️ Quickstart
|
||||||
- [**LocalRAG**](https://github.com/mudler/LocalRAG) — Local Retrieval-Augmented Generation
|
|
||||||
- [**LocalAgent**](https://github.com/mudler/LocalAgent) — Deploy AI agents that respect your privacy
|
|
||||||
|
|
||||||
## Features
|
|
||||||
|
|
||||||
### Powerful WebUI
|
|
||||||
|
|
||||||

|
|
||||||

|
|
||||||

|
|
||||||
|
|
||||||
|
|
||||||
### Connectors ready-to-go
|
|
||||||
|
|
||||||
<p align="center">
|
|
||||||
<img src="https://github.com/user-attachments/assets/4171072f-e4bf-4485-982b-55d55086f8fc" alt="Telegram Logo" width="60"/>
|
|
||||||
<img src="https://github.com/user-attachments/assets/9235da84-0187-4f26-8482-32dcc55702ef" alt="Discord Logo" width="220"/>
|
|
||||||
<img src="https://github.com/user-attachments/assets/a88c3d88-a387-4fb5-b513-22bdd5da7413" alt="Slack Logo" width="220"/>
|
|
||||||
<img src="https://github.com/user-attachments/assets/d249cdf5-ab34-4ab1-afdf-b99e2db182d2" alt="IRC Logo" width="220"/>
|
|
||||||
<img src="https://github.com/user-attachments/assets/52c852b0-4b50-4926-9fa0-aa50613ac622" alt="Github Logo" width="220"/>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
## QUICK START
|
|
||||||
|
|
||||||
### One-Command Docker Setup
|
|
||||||
|
|
||||||
The fastest way to get everything running — LocalRAG, LocalAI, and LocalAgent pre-configured:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker-compose up
|
# Clone the repository
|
||||||
```
|
git clone https://github.com/mudler/LocalAGI
|
||||||
|
cd LocalAGI
|
||||||
|
|
||||||
> No API keys. No cloud subscriptions. No external dependencies. Just AI that works.
|
# CPU setup
|
||||||
|
docker compose up -f docker-compose.yml
|
||||||
|
|
||||||
### Manual Launch
|
# GPU setup
|
||||||
|
docker compose up -f docker-compose.gpu.yml
|
||||||
Run the binary and you're live:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
./localagent
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Access your agents at `http://localhost:3000`
|
Access your agents at `http://localhost:3000`
|
||||||
|
|
||||||
|
## 🏆 Why Choose LocalAGI?
|
||||||
|
|
||||||
|
- **✓ Ultimate Privacy**: No data ever leaves your hardware.
|
||||||
|
- **✓ Flexible Model Integration**: Supports GGUF, GGML, and more.
|
||||||
|
- **✓ Developer-Friendly**: Rich APIs and intuitive interfaces.
|
||||||
|
- **✓ Effortless Setup**: Simple Docker setups and pre-built binaries.
|
||||||
|
- **✓ Platform Agnostic**: Works seamlessly on Linux, macOS, and Windows.
|
||||||
|
|
||||||
|
## 🌐 The Local Ecosystem
|
||||||
|
|
||||||
|
LocalAGI is part of the powerful Local family of privacy-focused AI tools:
|
||||||
|
|
||||||
|
- [**LocalAI**](https://github.com/mudler/LocalAI): Run Large Language Models locally.
|
||||||
|
- [**LocalRAG**](https://github.com/mudler/LocalRAG): Retrieval-Augmented Generation with local storage.
|
||||||
|
- [**LocalAGI**](https://github.com/mudler/LocalAGI): Deploy intelligent AI agents securely and privately.
|
||||||
|
|
||||||
|
## 🌟 Screenshots
|
||||||
|
|
||||||
|
### Powerful Web UI
|
||||||
|
|
||||||
|

|
||||||
|

|
||||||
|

|
||||||
|
|
||||||
|
### Connectors Ready-to-Go
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<img src="https://github.com/user-attachments/assets/4171072f-e4bf-4485-982b-55d55086f8fc" alt="Telegram" width="60"/>
|
||||||
|
<img src="https://github.com/user-attachments/assets/9235da84-0187-4f26-8482-32dcc55702ef" alt="Discord" width="220"/>
|
||||||
|
<img src="https://github.com/user-attachments/assets/a88c3d88-a387-4fb5-b513-22bdd5da7413" alt="Slack" width="220"/>
|
||||||
|
<img src="https://github.com/user-attachments/assets/d249cdf5-ab34-4ab1-afdf-b99e2db182d2" alt="IRC" width="220"/>
|
||||||
|
<img src="https://github.com/user-attachments/assets/52c852b0-4b50-4926-9fa0-aa50613ac622" alt="GitHub" width="220"/>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
## 📖 Full Documentation
|
||||||
|
|
||||||
|
Explore detailed documentation including:
|
||||||
|
- [Installation Options](#installation-options)
|
||||||
|
- [REST API Documentation](#rest-api)
|
||||||
|
- [Connector Configuration](#connectors)
|
||||||
|
- [Agent Configuration](#agent-configuration-reference)
|
||||||
|
|
||||||
### Environment Configuration
|
### Environment Configuration
|
||||||
|
|
||||||
| Variable | What It Does |
|
| Variable | What It Does |
|
||||||
@@ -93,7 +109,7 @@ Access your agents at `http://localhost:3000`
|
|||||||
| `LOCALAGENT_ENABLE_CONVERSATIONS_LOGGING` | Toggle conversation logs |
|
| `LOCALAGENT_ENABLE_CONVERSATIONS_LOGGING` | Toggle conversation logs |
|
||||||
| `LOCALAGENT_API_KEYS` | A comma separated list of api keys used for authentication |
|
| `LOCALAGENT_API_KEYS` | A comma separated list of api keys used for authentication |
|
||||||
|
|
||||||
## INSTALLATION OPTIONS
|
## Installation Options
|
||||||
|
|
||||||
### Pre-Built Binaries
|
### Pre-Built Binaries
|
||||||
|
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 1.1 MiB |
|
Before Width: | Height: | Size: 118 KiB |
|
Before Width: | Height: | Size: 886 KiB After Width: | Height: | Size: 933 KiB |
BIN
webui/old/public/logo_2.png
Normal file
|
After Width: | Height: | Size: 1.8 MiB |
@@ -7,7 +7,7 @@
|
|||||||
<!-- Logo with glow effect -->
|
<!-- Logo with glow effect -->
|
||||||
<a href="/old" class="flex items-center group">
|
<a href="/old" class="flex items-center group">
|
||||||
<div class="relative">
|
<div class="relative">
|
||||||
<img src="/old/public/logo_1.png" alt="Logo" class="h-10 w-auto mr-4 transition-transform duration-300 group-hover:scale-105"
|
<img src="/old/public/logo_2.png" alt="Logo" class="h-10 w-auto mr-4 transition-transform duration-300 group-hover:scale-105"
|
||||||
style="filter: drop-shadow(0 0 5px var(--primary));">
|
style="filter: drop-shadow(0 0 5px var(--primary));">
|
||||||
<!-- Animated scan line on hover -->
|
<!-- Animated scan line on hover -->
|
||||||
<div class="absolute inset-0 overflow-hidden opacity-0 group-hover:opacity-100 transition-opacity duration-300">
|
<div class="absolute inset-0 overflow-hidden opacity-0 group-hover:opacity-100 transition-opacity duration-300">
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
<html lang="en">
|
<html lang="en">
|
||||||
<head>
|
<head>
|
||||||
<meta charset="UTF-8" />
|
<meta charset="UTF-8" />
|
||||||
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
|
<link rel="icon" type="image/svg+xml" href="/logo.svg" />
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
<title>LocalAGI</title>
|
<title>LocalAGI</title>
|
||||||
</head>
|
</head>
|
||||||
|
|||||||
153
webui/react-ui/public/logo.svg
Normal file
|
After Width: | Height: | Size: 62 KiB |
|
Before Width: | Height: | Size: 886 KiB After Width: | Height: | Size: 933 KiB |
BIN
webui/react-ui/public/logo_2.png
Normal file
|
After Width: | Height: | Size: 1.8 MiB |
@@ -1 +0,0 @@
|
|||||||
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="31.88" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 257"><defs><linearGradient id="IconifyId1813088fe1fbc01fb466" x1="-.828%" x2="57.636%" y1="7.652%" y2="78.411%"><stop offset="0%" stop-color="#41D1FF"></stop><stop offset="100%" stop-color="#BD34FE"></stop></linearGradient><linearGradient id="IconifyId1813088fe1fbc01fb467" x1="43.376%" x2="50.316%" y1="2.242%" y2="89.03%"><stop offset="0%" stop-color="#FFEA83"></stop><stop offset="8.333%" stop-color="#FFDD35"></stop><stop offset="100%" stop-color="#FFA800"></stop></linearGradient></defs><path fill="url(#IconifyId1813088fe1fbc01fb466)" d="M255.153 37.938L134.897 252.976c-2.483 4.44-8.862 4.466-11.382.048L.875 37.958c-2.746-4.814 1.371-10.646 6.827-9.67l120.385 21.517a6.537 6.537 0 0 0 2.322-.004l117.867-21.483c5.438-.991 9.574 4.796 6.877 9.62Z"></path><path fill="url(#IconifyId1813088fe1fbc01fb467)" d="M185.432.063L96.44 17.501a3.268 3.268 0 0 0-2.634 3.014l-5.474 92.456a3.268 3.268 0 0 0 3.997 3.378l24.777-5.718c2.318-.535 4.413 1.507 3.936 3.838l-7.361 36.047c-.495 2.426 1.782 4.5 4.151 3.78l15.304-4.649c2.372-.72 4.652 1.36 4.15 3.788l-11.698 56.621c-.732 3.542 3.979 5.473 5.943 2.437l1.313-2.028l72.516-144.72c1.215-2.423-.88-5.186-3.54-4.672l-25.505 4.922c-2.396.462-4.435-1.77-3.759-4.114l16.646-57.705c.677-2.35-1.37-4.583-3.769-4.113Z"></path></svg>
|
|
||||||
|
Before Width: | Height: | Size: 1.5 KiB |
@@ -189,7 +189,7 @@ a:hover {
|
|||||||
}
|
}
|
||||||
|
|
||||||
.logo-image {
|
.logo-image {
|
||||||
height: 40px;
|
height: 110px;
|
||||||
width: auto;
|
width: auto;
|
||||||
transition: transform 0.3s ease;
|
transition: transform 0.3s ease;
|
||||||
filter: drop-shadow(0 0 5px var(--primary));
|
filter: drop-shadow(0 0 5px var(--primary));
|
||||||
|
|||||||
@@ -29,9 +29,9 @@ function App() {
|
|||||||
{/* Logo with glow effect */}
|
{/* Logo with glow effect */}
|
||||||
<Link to="/" className="logo-link">
|
<Link to="/" className="logo-link">
|
||||||
<div className="logo-image-container">
|
<div className="logo-image-container">
|
||||||
<img src="/app/logo_1.png" alt="Logo" className="logo-image" />
|
<img src="/app/logo_2.png" alt="Logo" className="logo-image" />
|
||||||
</div>
|
</div>
|
||||||
<span className="logo-text">LocalAgent</span>
|
{/* <span className="logo-text">LocalAgent</span> */}
|
||||||
</Link>
|
</Link>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|||||||
@@ -60,7 +60,7 @@ function Home() {
|
|||||||
<img src="/app/logo_1.png" width="250" alt="LocalAgent Logo" />
|
<img src="/app/logo_1.png" width="250" alt="LocalAgent Logo" />
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<h1 className="dashboard-title">LocalAgent</h1>
|
{/*<h1 className="dashboard-title">LocalAgent</h1>*/}
|
||||||
|
|
||||||
{/* Dashboard Stats */}
|
{/* Dashboard Stats */}
|
||||||
<div className="dashboard-stats">
|
<div className="dashboard-stats">
|
||||||
|
|||||||