agdi 2026.2.18 → 2026.2.19
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +66 -54
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,12 +1,26 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
<p align="center">
|
|
1
|
+
<!-- Hero Section -->
|
|
2
|
+
<div align="center">
|
|
4
3
|
<img src="https://raw.githubusercontent.com/agdi/agdi/main/docs/assets/agdi-logo-text.png" alt="Agdi" width="500">
|
|
5
|
-
</p>
|
|
6
4
|
|
|
7
|
-
<
|
|
8
|
-
|
|
9
|
-
|
|
5
|
+
<h3>A Full-Stack, Cross-Platform Autonomous AI Agent Gateway</h3>
|
|
6
|
+
|
|
7
|
+
<p>
|
|
8
|
+
<a href="https://www.npmjs.com/package/agdi"><img src="https://img.shields.io/npm/v/agdi.svg?style=flat-square&color=black" alt="NPM Version" /></a>
|
|
9
|
+
<a href="https://github.com/agdi/agdi/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square&color=black" alt="License" /></a>
|
|
10
|
+
<a href="https://github.com/agdi/agdi/issues"><img src="https://img.shields.io/github/issues/agdi/agdi.svg?style=flat-square&color=black" alt="Issues" /></a>
|
|
11
|
+
<a href="https://docs.agdi.ai/"><img src="https://img.shields.io/badge/docs-Mintlify-blue?style=flat-square&color=black" alt="Docs" /></a>
|
|
12
|
+
</p>
|
|
13
|
+
|
|
14
|
+
<p>
|
|
15
|
+
<strong><a href="https://docs.agdi.ai/">Documentation</a></strong>
|
|
16
|
+
·
|
|
17
|
+
<strong><a href="https://agdi.ai">Website</a></strong>
|
|
18
|
+
·
|
|
19
|
+
<strong><a href="https://discord.gg/u7m4FpP">Community Discord</a></strong>
|
|
20
|
+
</p>
|
|
21
|
+
</div>
|
|
22
|
+
|
|
23
|
+
---
|
|
10
24
|
|
|
11
25
|
## 🚀 What is Agdi?
|
|
12
26
|
|
|
@@ -14,91 +28,87 @@
|
|
|
14
28
|
|
|
15
29
|
Designed for individuals and teams who need deep integration and absolute control, Agdi runs wherever Node.js runs—managing everything from secure code execution to seamless cross-platform messaging integration.
|
|
16
30
|
|
|
17
|
-
### Core Capabilities
|
|
18
|
-
|
|
19
|
-
* **Next.js SSR Command Center (`apps/dashboard`)**
|
|
20
|
-
* A highly performant, state-of-the-art React frontend featuring unified dashboards, glassmorphism UI/UX paradigms, and dynamic controls for managing your AI Agents, User Profiles, and API Keys.
|
|
21
|
-
* **Real-Time WebSocket Tracing Telemetry (`src/gateway`)**
|
|
22
|
-
* A low-latency orchestrator that streams live agent steps, tool executions, and LLM reasoning directly to your browser via an interactive "waterfall" tracing timeline.
|
|
23
|
-
* **Native Vector Database & RAG Platform**
|
|
24
|
-
* An integrated Retrieval-Augmented Generation (RAG) pipeline powered by local **LanceDB**.
|
|
25
|
-
* Simply Drag-and-Drop documents into the knowledge base to instantly scale your AI's custom context window.
|
|
26
|
-
* **Cross-Platform Deep Linking & Notification Approvals**
|
|
27
|
-
* Designed with a secure human-in-the-loop authorization system for destructive or sensitive commands.
|
|
28
|
-
* Push notifications wake up your devices and drop you straight into native approval flows.
|
|
29
|
-
|
|
30
31
|
---
|
|
31
32
|
|
|
32
|
-
##
|
|
33
|
+
## ⚡ Quick Start (Recommended)
|
|
33
34
|
|
|
34
|
-
|
|
35
|
-
* **Backend**: Node.js, TypeScript (ESM), WebSockets (ws), LanceDB (Vector Search).
|
|
36
|
-
* **Mobile / Native**: Swift (iOS / macOS bridging), Kotlin (Android Manifest & Intents).
|
|
37
|
-
* **AI / Integrations**: Anthropic Claude API, OpenAI API, ElevenLabs.
|
|
38
|
-
* **Infrastructure**: Tailscale Serve/Funnel integration, OAuth flows.
|
|
39
|
-
|
|
40
|
-
---
|
|
41
|
-
|
|
42
|
-
## 💻 Running the Project Locally
|
|
43
|
-
|
|
44
|
-
The framework is composed of the **Node.js Gateway** (backend) and the **Next.js Dashboard** (frontend).
|
|
45
|
-
|
|
46
|
-
### ⚡ Quick Install (Recommended)
|
|
47
|
-
|
|
48
|
-
You can install Agdi directly to your system with our one-command installer. This will automatically configure Node.js and the CLI.
|
|
35
|
+
You can install Agdi directly to your system with our one-command installer. This automatically configures Node.js, sets up the CLI, and registers the global `agdi` command.
|
|
49
36
|
|
|
50
37
|
**macOS & Linux:**
|
|
51
38
|
```bash
|
|
52
39
|
curl -fsSL https://raw.githubusercontent.com/anassagd432/Agdi/main/install.sh | bash
|
|
53
40
|
```
|
|
54
|
-
|
|
55
41
|
**Windows (PowerShell):**
|
|
56
42
|
```powershell
|
|
57
43
|
irm https://raw.githubusercontent.com/anassagd432/Agdi/main/install.ps1 | iex
|
|
58
44
|
```
|
|
59
|
-
|
|
60
45
|
*Alternatively, install globally via npm:*
|
|
61
46
|
```bash
|
|
62
47
|
npm install -g agdi
|
|
63
48
|
```
|
|
64
49
|
|
|
65
|
-
|
|
50
|
+
---
|
|
51
|
+
|
|
52
|
+
## 🌟 Core Features
|
|
53
|
+
|
|
54
|
+
### 🧠 Multi-Agent Orchestration & RAG
|
|
55
|
+
Run fully isolated agents with distinct Prompts, sandboxed execution tools, and constraints. Integrated with **LanceDB**, you can seamlessly "Drag-and-Drop" documents to embed custom RAG knowledge directly into your agent's context window.
|
|
66
56
|
|
|
67
|
-
|
|
68
|
-
|
|
57
|
+
### 💬 Deep Messaging Integrations
|
|
58
|
+
Don't be locked into a web chat. Agdi natively routes your multi-agent teams directly into the platforms you already use:
|
|
59
|
+
> WhatsApp • Telegram • Slack • Discord • Signal • iMessage • Microsoft Teams
|
|
60
|
+
|
|
61
|
+
### ⚡ Real-Time Telemetry & Next.js Command Center
|
|
62
|
+
Visually trace your agent's internal Node.js LLM reasoning, code executions, and API calls via our interactive websocket waterfall dashboard built on a high-performance **Next.js & React 18** architecture featuring glassmorphism UI/UX.
|
|
63
|
+
|
|
64
|
+
### 📱 Native Deep Linking & Zero-Trust Safety
|
|
65
|
+
By default, all destructive or sensitive sandbox actions are gated. Agdi uses asynchronous notification dispatchers to wake up your mobile devices using native bridging (`agdi://approval`) to prompt you for a human-in-the-loop authorization.
|
|
66
|
+
|
|
67
|
+
---
|
|
68
|
+
|
|
69
|
+
## 🛠️ Architecture & Technology Stack
|
|
70
|
+
|
|
71
|
+
Agdi is engineered as a modern, distributed architecture combining a scalable backend orchestrator with an interactive frontend application.
|
|
72
|
+
|
|
73
|
+
| Domain | Technologies |
|
|
74
|
+
| :--- | :--- |
|
|
75
|
+
| **Frontend Platform** | Next.js 14, React 18, Tailwind CSS, Framer Motion |
|
|
76
|
+
| **Backend Gateway** | Node.js, TypeScript (ESM), WebSockets (ws) |
|
|
77
|
+
| **Vector Database** | LanceDB (Local RAG Pipeline) |
|
|
78
|
+
| **Mobile Integration** | Swift (iOS Deep Links), Kotlin (Android Intents) |
|
|
79
|
+
| **Supported Models** | OpenAI, Anthropic Claude, ElevenLabs TTS |
|
|
80
|
+
|
|
81
|
+
---
|
|
82
|
+
|
|
83
|
+
## 💻 Running the Project from Source
|
|
84
|
+
|
|
85
|
+
The framework is composed of the **Node.js Gateway** (backend) and the **Next.js Dashboard** (frontend).
|
|
86
|
+
|
|
87
|
+
**Prerequisites:** Node.js ≥ 22 and `pnpm`.
|
|
69
88
|
|
|
70
89
|
### 1. Start the Backend Gateway
|
|
71
90
|
The gateway orchestrates LLM routing, WebSocket connections, and external channel webhooks.
|
|
72
91
|
|
|
73
92
|
```bash
|
|
74
|
-
git clone https://github.com/
|
|
75
|
-
cd
|
|
93
|
+
git clone https://github.com/anassagd432/Agdi.git
|
|
94
|
+
cd Agdi
|
|
76
95
|
pnpm install
|
|
77
96
|
pnpm build
|
|
78
97
|
|
|
79
98
|
# Boot up the Gateway locally on port 18789
|
|
80
99
|
pnpm agdi gateway run --bind loopback --port 18789 --verbose
|
|
81
|
-
```
|
|
82
100
|
|
|
83
101
|
### 2. Start the Frontend Dashboard
|
|
84
102
|
The Next.js interactive Command Center.
|
|
85
|
-
|
|
86
103
|
```bash
|
|
87
104
|
cd apps/dashboard
|
|
88
105
|
pnpm install
|
|
89
106
|
pnpm dev
|
|
90
107
|
```
|
|
91
|
-
Navigate to
|
|
108
|
+
Navigate to [http://localhost:3000](http://localhost:3000) to view the comprehensive UI.
|
|
92
109
|
|
|
93
110
|
---
|
|
94
111
|
|
|
95
|
-
## Features
|
|
96
|
-
|
|
97
|
-
* **Multi-Channel Inbox**: Connects natively to WhatsApp, Telegram, Slack, Discord, Signal, iMessage, and Microsoft Teams.
|
|
98
|
-
* **Multi-Agent Routing**: Route inbound channels and users to fully isolated agents with distinct Prompts, system tools, and constraints.
|
|
99
|
-
* **Code Capabilities**: Agents can execute secure code natively via temporary sandboxed environments, write files, and scrape the web via dedicated CDP Chromium.
|
|
100
|
-
* **Live Canvas Workspace**: Fully interactive agent-driven UI where the assistant can push visual blocks (Markdown, Code, SVG, and structured JSON components).
|
|
101
|
-
|
|
102
112
|
## 🔒 Security Model
|
|
103
113
|
|
|
104
114
|
Agdi was built with a zero-trust architecture in mind for its execution capabilities.
|
|
@@ -109,4 +119,6 @@ Agdi was built with a zero-trust architecture in mind for its execution capabili
|
|
|
109
119
|
|
|
110
120
|
---
|
|
111
121
|
|
|
112
|
-
>
|
|
122
|
+
<div align="center">
|
|
123
|
+
<p><strong><a href="https://docs.agdi.ai">Read the Full Documentation</a></strong></p>
|
|
124
|
+
</div>
|