Skip to content

Commit 6d1a977

Browse files
committed
feat(docs): add API gateway, MCP server, and getting started guides
1 parent 1ce5ba7 commit 6d1a977

113 files changed

Lines changed: 17526 additions & 364 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README-AR.md

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
[简体中文](./README.md) | [繁體中文](./README-ZH-TW.md) | [English](./README-EN.md) | [日本語](./README-JA.md) | [한국어](./README-KO.md) | [Français](./README-FR.md) | [Deutsch](./README-DE.md) | [Español](./README-ES.md) | [Русский](./README-RU.md) | [हिन्दी](./README-HI.md) | **العربية**
2+
3+
[![AQBot](https://socialify.git.ci/AQBot-Desktop/AQBot/image?description=1&font=JetBrains+Mono&forks=1&issues=1&logo=https%3A%2F%2Fgithub.com%2FAQBot-Desktop%2FAQBot%2Fblob%2Fmain%2Fsrc%2Fassets%2Fimage%2Flogo.png%3Fraw%3Dtrue&name=1&owner=1&pattern=Floating+Cogs&pulls=1&stargazers=1&theme=Auto)](https://github.com/AQBot-Desktop/AQBot)
4+
5+
## لقطات الشاشة
6+
7+
![](.github/images/1.png)
8+
![](.github/images/2.png)
9+
![](.github/images/3.png)
10+
![](.github/images/4.png)
11+
![](.github/images/5.png)
12+
13+
## الميزات
14+
15+
### الدردشة والنماذج
16+
17+
- **دعم متعدد المزودين** — متوافق مع OpenAI وAnthropic Claude وGoogle Gemini وجميع واجهات برمجة التطبيقات المتوافقة مع OpenAI
18+
- **إدارة النماذج** — جلب قوائم النماذج عن بُعد، وتخصيص المعاملات (درجة الحرارة، الحد الأقصى للرموز المميزة، Top-P، إلخ)
19+
- **تدوير متعدد المفاتيح** — تكوين مفاتيح API متعددة لكل مزود مع التدوير التلقائي لتوزيع ضغط حد المعدل
20+
- **الإخراج المتدفق** — عرض في الوقت الفعلي رمزاً بعد رمز مع كتل تفكير قابلة للطي
21+
- **إصدارات الرسائل** — التبديل بين إصدارات متعددة للاستجابة لكل رسالة لمقارنة تأثيرات النموذج أو المعاملات
22+
- **تفريع المحادثة** — إنشاء فروع جديدة من أي عقدة رسالة، مع مقارنة الفروع جنباً إلى جنب
23+
- **إدارة المحادثات** — التثبيت والأرشفة والعرض المجمّع حسب الوقت والعمليات الجماعية
24+
- **ضغط المحادثة** — ضغط المحادثات الطويلة تلقائياً مع الحفاظ على المعلومات الرئيسية لتوفير مساحة السياق
25+
- **استجابة متزامنة لنماذج متعددة** — طرح نفس السؤال على نماذج متعددة في آنٍ واحد، مع مقارنة الإجابات جنباً إلى جنب
26+
27+
### عرض المحتوى
28+
29+
- **عرض Markdown** — دعم كامل لتمييز الكود وصيغ الرياضيات LaTeX والجداول وقوائم المهام
30+
- **محرر كود Monaco** — Monaco Editor مضمّن في كتل الكود مع تمييز بناء الجملة والنسخ ومعاينة diff
31+
- **عرض المخططات** — عرض مدمج لمخططات تدفق Mermaid ومخططات بنية D2
32+
- **لوحة Artifact** — مقتطفات الكود ومسودات HTML وملاحظات Markdown والتقارير قابلة للعرض في لوحة مخصصة
33+
- **دردشة صوتية في الوقت الفعلي** — (قريباً) صوت في الوقت الفعلي قائم على WebRTC مع دعم OpenAI Realtime API
34+
35+
### البحث والمعرفة
36+
37+
- **بحث الويب** — متكامل مع Tavily وZhipu WebSearch وBocha والمزيد، مع تعليقات توضيحية لمصادر الاستشهاد
38+
- **قاعدة المعرفة المحلية (RAG)** — يدعم قواعد معرفة متعددة؛ تحميل المستندات لتحليل وتقطيع وفهرسة تلقائية، مع الاسترداد الدلالي للمقاطع ذات الصلة أثناء المحادثات
39+
- **نظام الذاكرة** — يدعم ذاكرة المحادثة متعددة مساحات الأسماء، مع إدخال يدوي أو استخراج تلقائي بالذكاء الاصطناعي (الاستخراج التلقائي قريباً)
40+
- **إدارة السياق** — إرفاق مرفقات الملفات ونتائج البحث ومقاطع قاعدة المعرفة وإدخالات الذاكرة ومخرجات الأدوات بمرونة
41+
42+
### الأدوات والامتدادات
43+
44+
- **بروتوكول MCP** — تطبيق كامل لـ Model Context Protocol يدعم نقلَي stdio وHTTP
45+
- **الأدوات المدمجة** — أدوات MCP مدمجة جاهزة للاستخدام مثل `@aqbot/fetch`
46+
- **لوحة تنفيذ الأدوات** — عرض مرئي لطلبات استدعاء الأدوات والنتائج المُعادة
47+
48+
### بوابة API
49+
50+
- **بوابة API محلية** — خادم API محلي مدمج مع دعم أصلي لواجهات متوافقة مع OpenAI وClaude وGemini، قابل للاستخدام كخلفية لأي عميل متوافق
51+
- **إدارة مفاتيح API** — توليد مفاتيح الوصول وإلغاؤها وتمكينها/تعطيلها مع ملاحظات وصفية
52+
- **تحليلات الاستخدام** — تحليل حجم الطلبات واستخدام الرموز المميزة حسب المفتاح والمزود والتاريخ
53+
- **دعم SSL/TLS** — توليد شهادات موقّعة ذاتياً مدمج، مع دعم الشهادات المخصصة
54+
- **سجلات الطلبات** — تسجيل كامل لجميع طلبات واستجابات API المارة عبر البوابة
55+
- **قوالب التكوين** — قوالب تكامل مسبقة البناء لأدوات CLI الشائعة مثل Claude وCodex وOpenCode وGemini
56+
57+
### البيانات والأمان
58+
59+
- **تشفير AES-256** — مفاتيح API والبيانات الحساسة مشفرة محلياً بـ AES-256؛ المفتاح الرئيسي مخزّن بأذونات 0600
60+
- **أدلة بيانات معزولة** — حالة التطبيق في `~/.aqbot/`؛ ملفات المستخدم في `~/Documents/aqbot/`
61+
- **النسخ الاحتياطي التلقائي** — نسخ احتياطية تلقائية مجدولة إلى أدلة محلية أو تخزين WebDAV
62+
- **استعادة النسخ الاحتياطي** — استعادة بنقرة واحدة من النسخ الاحتياطية التاريخية
63+
- **تصدير المحادثات** — تصدير المحادثات كلقطات PNG أو Markdown أو نص عادي أو JSON
64+
65+
### تجربة سطح المكتب
66+
67+
- **تبديل السمة** — سمات داكنة/فاتحة تتبع تفضيلات النظام أو يمكن ضبطها يدوياً
68+
- **لغة الواجهة** — دعم كامل للصينية المبسطة والصينية التقليدية والإنجليزية واليابانية والكورية والفرنسية والألمانية والإسبانية والروسية والهندية والعربية، قابلة للتبديل في أي وقت من الإعدادات
69+
- **صينية النظام** — التصغير إلى صينية النظام عند إغلاق النافذة دون مقاطعة الخدمات الخلفية
70+
- **دائماً في المقدمة** — تثبيت النافذة الرئيسية فوق جميع النوافذ الأخرى
71+
- **اختصارات عالمية** — اختصارات لوحة مفاتيح عالمية قابلة للتخصيص لاستدعاء النافذة الرئيسية في أي وقت
72+
- **التشغيل التلقائي** — إطلاق اختياري عند بدء تشغيل النظام
73+
- **دعم الوكيل** — تكوين وكيل HTTP وSOCKS5
74+
- **التحديث التلقائي** — يتحقق تلقائياً من الإصدارات الجديدة عند بدء التشغيل ويطلب التحديث
75+
76+
## دعم المنصات
77+
78+
| المنصة | البنية |
79+
|--------|--------|
80+
| macOS | Apple Silicon (arm64), Intel (x86_64) |
81+
| Windows 10/11 | x86_64, arm64 |
82+
| Linux | x86_64 (AppImage/deb/rpm), arm64 (AppImage/deb/rpm) |
83+
84+
## البدء
85+
86+
توجه إلى صفحة [Releases](https://github.com/AQBot-Desktop/AQBot/releases) وقم بتنزيل المثبّت الخاص بمنصتك.
87+
88+
## الأسئلة الشائعة
89+
90+
### macOS: «التطبيق تالف» أو «لا يمكن التحقق من المطور»
91+
92+
نظراً لأن التطبيق غير موقّع من Apple، قد يعرض macOS أحد الرسائل التالية:
93+
94+
- «AQBot» تالف ولا يمكن فتحه
95+
- لا يمكن فتح «AQBot» لأن Apple لا تستطيع التحقق منه بحثاً عن البرامج الضارة
96+
97+
**خطوات الحل:**
98+
99+
**1. السماح بالتطبيقات من «أي مكان»**
100+
101+
```bash
102+
sudo spctl --master-disable
103+
```
104+
105+
ثم انتقل إلى **إعدادات النظام ← الخصوصية والأمان ← الأمان** وحدد **أي مكان**.
106+
107+
**2. إزالة سمة الحجر الصحي**
108+
109+
```bash
110+
sudo xattr -dr com.apple.quarantine /Applications/AQBot.app
111+
```
112+
113+
> تلميح: يمكنك سحب أيقونة التطبيق إلى الطرفية بعد كتابة `sudo xattr -dr com.apple.quarantine `.
114+
115+
**3. خطوة إضافية لـ macOS Ventura والإصدارات الأحدث**
116+
117+
بعد إتمام الخطوات أعلاه، قد يظل الإطلاق الأول محجوباً. انتقل إلى **إعدادات النظام ← الخصوصية والأمان**، ثم انقر على **فتح على أي حال** في قسم الأمان. هذا يحتاج إلى تنفيذه مرة واحدة فقط.
118+
119+
## المجتمع
120+
- [LinuxDO](https://linux.do)
121+
122+
## الترخيص
123+
124+
هذا المشروع مرخّص بموجب ترخيص [AGPL-3.0](LICENSE).

README-DE.md

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
[简体中文](./README.md) | [繁體中文](./README-ZH-TW.md) | [English](./README-EN.md) | [日本語](./README-JA.md) | [한국어](./README-KO.md) | [Français](./README-FR.md) | **Deutsch** | [Español](./README-ES.md) | [Русский](./README-RU.md) | [हिन्दी](./README-HI.md) | [العربية](./README-AR.md)
2+
3+
[![AQBot](https://socialify.git.ci/AQBot-Desktop/AQBot/image?description=1&font=JetBrains+Mono&forks=1&issues=1&logo=https%3A%2F%2Fgithub.com%2FAQBot-Desktop%2FAQBot%2Fblob%2Fmain%2Fsrc%2Fassets%2Fimage%2Flogo.png%3Fraw%3Dtrue&name=1&owner=1&pattern=Floating+Cogs&pulls=1&stargazers=1&theme=Auto)](https://github.com/AQBot-Desktop/AQBot)
4+
5+
## Screenshots
6+
7+
![](.github/images/1.png)
8+
![](.github/images/2.png)
9+
![](.github/images/3.png)
10+
![](.github/images/4.png)
11+
![](.github/images/5.png)
12+
13+
## Funktionen
14+
15+
### Chat & Modelle
16+
17+
- **Multi-Anbieter-Unterstützung** — Kompatibel mit OpenAI, Anthropic Claude, Google Gemini und allen OpenAI-kompatiblen APIs
18+
- **Modellverwaltung** — Remote-Modelllisten abrufen, Parameter anpassen (Temperatur, maximale Tokens, Top-P usw.)
19+
- **Multi-Key-Rotation** — Mehrere API-Schlüssel pro Anbieter konfigurieren mit automatischer Rotation zur Verteilung des Rate-Limit-Drucks
20+
- **Streaming-Ausgabe** — Echtzeit-Token-für-Token-Rendering mit einklappbaren Denkblöcken
21+
- **Nachrichtenversionen** — Zwischen mehreren Antwortversionen pro Nachricht wechseln, um Modell- oder Parametereffekte zu vergleichen
22+
- **Gesprächsverzweigung** — Neue Zweige von einem beliebigen Nachrichtenknoten erstellen, mit seitenweisem Zweigvergleich
23+
- **Gesprächsverwaltung** — Anheften, Archivieren, zeitgruppierte Anzeige und Massenoperationen
24+
- **Gesprächskomprimierung** — Lange Gespräche automatisch komprimieren und dabei wichtige Informationen beibehalten, um Kontextraum zu sparen
25+
- **Simultane Multi-Modell-Antwort** — Dieselbe Frage gleichzeitig an mehrere Modelle stellen, mit seitenweisem Antwortvergleich
26+
27+
### Inhaltsrendering
28+
29+
- **Markdown-Rendering** — Vollständige Unterstützung für Code-Hervorhebung, LaTeX-Mathematikformeln, Tabellen und Aufgabenlisten
30+
- **Monaco Code-Editor** — Monaco Editor in Codeblöcken eingebettet mit Syntaxhervorhebung, Kopieren und Diff-Vorschau
31+
- **Diagramm-Rendering** — Integriertes Rendering von Mermaid-Flussdiagrammen und D2-Architekturdiagrammen
32+
- **Artifact-Panel** — Codeausschnitte, HTML-Entwürfe, Markdown-Notizen und Berichte in einem dedizierten Panel anzeigen
33+
- **Echtzeit-Sprachchat** — (Demnächst) WebRTC-basierte Echtzeit-Sprache mit Unterstützung der OpenAI Realtime API
34+
35+
### Suche & Wissen
36+
37+
- **Websuche** — Integriert mit Tavily, Zhipu WebSearch, Bocha und mehr, mit Quellenangaben
38+
- **Lokale Wissensbasis (RAG)** — Unterstützt mehrere Wissensbasen; Dokumente hochladen für automatisches Parsen, Chunking und Indexierung, mit semantischer Abrufung relevanter Abschnitte während Gesprächen
39+
- **Gedächtnissystem** — Unterstützt Multi-Namespace-Gesprächsgedächtnis, mit manueller Eingabe oder KI-gestützter automatischer Extraktion (automatische Extraktion demnächst)
40+
- **Kontextverwaltung** — Flexibles Anhängen von Dateianhängen, Suchergebnissen, Wissensbasisabschnitten, Gedächtniseinträgen und Werkzeugausgaben
41+
42+
### Werkzeuge & Erweiterungen
43+
44+
- **MCP-Protokoll** — Vollständige Model Context Protocol-Implementierung mit Unterstützung für stdio- und HTTP-Transporte
45+
- **Integrierte Werkzeuge** — Sofort einsatzbereite integrierte MCP-Werkzeuge wie `@aqbot/fetch`
46+
- **Werkzeugausführungs-Panel** — Visuelle Anzeige von Werkzeugaufruf-Anfragen und zurückgegebenen Ergebnissen
47+
48+
### API-Gateway
49+
50+
- **Lokales API-Gateway** — Integrierter lokaler API-Server mit nativer Unterstützung für OpenAI-kompatible, Claude- und Gemini-Schnittstellen, verwendbar als Backend für jeden kompatiblen Client
51+
- **API-Schlüsselverwaltung** — Zugriffsschlüssel generieren, widerrufen und aktivieren/deaktivieren mit Beschreibungsnotizen
52+
- **Nutzungsanalyse** — Anfragevolumen und Token-Nutzungsanalyse nach Schlüssel, Anbieter und Datum
53+
- **SSL/TLS-Unterstützung** — Integrierte Generierung selbstsignierter Zertifikate, mit Unterstützung für benutzerdefinierte Zertifikate
54+
- **Anfrage-Logs** — Vollständige Aufzeichnung aller API-Anfragen und -Antworten, die das Gateway passieren
55+
- **Konfigurationsvorlagen** — Vorgefertigte Integrationsvorlagen für beliebte CLI-Tools wie Claude, Codex, OpenCode und Gemini
56+
57+
### Daten & Sicherheit
58+
59+
- **AES-256-Verschlüsselung** — API-Schlüssel und sensible Daten werden lokal mit AES-256 verschlüsselt; Master-Schlüssel mit 0600-Berechtigungen gespeichert
60+
- **Isolierte Datenverzeichnisse** — Anwendungsstatus in `~/.aqbot/`; Benutzerdateien in `~/Documents/aqbot/`
61+
- **Automatisches Backup** — Geplante automatische Backups in lokale Verzeichnisse oder WebDAV-Speicher
62+
- **Backup-Wiederherstellung** — Ein-Klick-Wiederherstellung aus historischen Backups
63+
- **Gesprächsexport** — Gespräche als PNG-Screenshots, Markdown, Klartext oder JSON exportieren
64+
65+
### Desktop-Erfahrung
66+
67+
- **Themenwechsel** — Dunkle/helle Themes, die den Systemeinstellungen folgen oder manuell festgelegt werden können
68+
- **Oberflächensprache** — Vollständige Unterstützung für vereinfachtes Chinesisch, traditionelles Chinesisch, Englisch, Japanisch, Koreanisch, Französisch, Deutsch, Spanisch, Russisch, Hindi und Arabisch, jederzeit in den Einstellungen umschaltbar
69+
- **Systemtray** — Beim Schließen des Fensters in den Systemtray minimieren, ohne Hintergrunddienste zu unterbrechen
70+
- **Immer im Vordergrund** — Das Hauptfenster über allen anderen Fenstern anheften
71+
- **Globale Tastenkürzel** — Anpassbare globale Tastaturkürzel, um das Hauptfenster jederzeit aufzurufen
72+
- **Autostart** — Optionaler Start beim Systemstart
73+
- **Proxy-Unterstützung** — HTTP- und SOCKS5-Proxy-Konfiguration
74+
- **Automatische Updates** — Prüft beim Start automatisch auf neue Versionen und fordert zur Aktualisierung auf
75+
76+
## Plattformunterstützung
77+
78+
| Plattform | Architektur |
79+
|-----------|------------|
80+
| macOS | Apple Silicon (arm64), Intel (x86_64) |
81+
| Windows 10/11 | x86_64, arm64 |
82+
| Linux | x86_64 (AppImage/deb/rpm), arm64 (AppImage/deb/rpm) |
83+
84+
## Erste Schritte
85+
86+
Gehen Sie zur [Releases](https://github.com/AQBot-Desktop/AQBot/releases)-Seite und laden Sie das Installationsprogramm für Ihre Plattform herunter.
87+
88+
## FAQ
89+
90+
### macOS: „App ist beschädigt" oder „Entwickler kann nicht überprüft werden"
91+
92+
Da die Anwendung nicht von Apple signiert ist, kann macOS eine der folgenden Meldungen anzeigen:
93+
94+
- „AQBot" ist beschädigt und kann nicht geöffnet werden
95+
- „AQBot" kann nicht geöffnet werden, da Apple es nicht auf Schadsoftware überprüfen kann
96+
97+
**Lösungsschritte:**
98+
99+
**1. Apps aus „Beliebiger Herkunft" zulassen**
100+
101+
```bash
102+
sudo spctl --master-disable
103+
```
104+
105+
Gehen Sie dann zu **Systemeinstellungen → Datenschutz & Sicherheit → Sicherheit** und wählen Sie **Beliebige Herkunft**.
106+
107+
**2. Das Quarantäne-Attribut entfernen**
108+
109+
```bash
110+
sudo xattr -dr com.apple.quarantine /Applications/AQBot.app
111+
```
112+
113+
> Tipp: Sie können das App-Symbol in das Terminal ziehen, nachdem Sie `sudo xattr -dr com.apple.quarantine ` eingegeben haben.
114+
115+
**3. Zusätzlicher Schritt für macOS Ventura und höher**
116+
117+
Nach Abschluss der obigen Schritte kann der erste Start immer noch blockiert werden. Gehen Sie zu **Systemeinstellungen → Datenschutz & Sicherheit** und klicken Sie im Sicherheitsbereich auf **Trotzdem öffnen**. Dies muss nur einmal durchgeführt werden.
118+
119+
## Community
120+
- [LinuxDO](https://linux.do)
121+
122+
## Lizenz
123+
124+
Dieses Projekt ist unter der [AGPL-3.0](LICENSE)-Lizenz lizenziert.

README-EN.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[简体中文](./README.md) | English
1+
[简体中文](./README.md) | [繁體中文](./README-ZH-TW.md) | **English** | [日本語](./README-JA.md) | [한국어](./README-KO.md) | [Français](./README-FR.md) | [Deutsch](./README-DE.md) | [Español](./README-ES.md) | [Русский](./README-RU.md) | [हिन्दी](./README-HI.md) | [العربية](./README-AR.md)
22

33
[![AQBot](https://socialify.git.ci/AQBot-Desktop/AQBot/image?description=1&font=JetBrains+Mono&forks=1&issues=1&logo=https%3A%2F%2Fgithub.com%2FAQBot-Desktop%2FAQBot%2Fblob%2Fmain%2Fsrc%2Fassets%2Fimage%2Flogo.png%3Fraw%3Dtrue&name=1&owner=1&pattern=Floating+Cogs&pulls=1&stargazers=1&theme=Auto)](https://github.com/AQBot-Desktop/AQBot)
44

@@ -65,7 +65,7 @@
6565
### Desktop Experience
6666

6767
- **Theme Switching** — Dark/light themes that follow the system preference or can be set manually
68-
- **Interface Language** — Full support for Simplified Chinese and English, switchable at any time in settings
68+
- **Interface Language** — Full support for Simplified Chinese, Traditional Chinese, English, Japanese, Korean, French, German, Spanish, Russian, Hindi, and Arabic, switchable at any time in settings
6969
- **System Tray** — Minimize to system tray on window close without interrupting background services
7070
- **Always on Top** — Pin the main window to stay above all other windows
7171
- **Global Shortcuts** — Customizable global keyboard shortcuts to summon the main window at any time

0 commit comments

Comments
 (0)