Skip to content

Commit 297dda6

Browse files
kwannzkwannz
authored
update
1 parent 68a8054 commit 297dda6

18 files changed

+2573
-0
lines changed

‎README.md

+150
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
# Eliza 🤖
2+
3+
<div align="center">
4+
<img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
5+
</div>
6+
7+
<div align="center">
8+
9+
📖 [Documentation](https://elizaos.github.io/eliza/) | 🎯 [Examples](https://github.com/thejoven/awesome-eliza)
10+
11+
</div>
12+
13+
## 🌍 README Translations
14+
15+
[中文说明](./README_CN.md) | [日本語の説明](./README_JA.md) | [한국어 설명](./README_KOR.md) | [Français](./README_FR.md) | [Português](./README_PTBR.md) | [Türkçe](./README_TR.md) | [Русский](./README_RU.md) | [Español](./README_ES.md) | [Italiano](./README_IT.md) | [ไทย](./README_TH.md) | [Deutsch](./README_DE.md) | [Tiếng Việt](./README_VI.md) | [עִברִית](https://github.com/elizaos/Elisa/blob/main/README_HE.md) | [Tagalog](./README_TG.md) | [Polski](./README_PL.md) | [Arabic](./README_AR.md) | [Hungarian](./README_HU.md) | [Srpski](./README_RS.md)
16+
17+
## 🚩 Overview
18+
19+
<div align="center">
20+
<img src="./docs/static/img/eliza_diagram.jpg" alt="Eliza Diagram" width="100%" />
21+
</div>
22+
23+
## ✨ Features
24+
25+
- 🛠️ Full-featured Discord, Twitter and Telegram connectors
26+
- 🔗 Support for every model (Llama, Grok, OpenAI, Anthropic, etc.)
27+
- 👥 Multi-agent and room support
28+
- 📚 Easily ingest and interact with your documents
29+
- 💾 Retrievable memory and document store
30+
- 🚀 Highly extensible - create your own actions and clients
31+
- ☁️ Supports many models (local Llama, OpenAI, Anthropic, Groq, etc.)
32+
- 📦 Just works!
33+
34+
## Video Tutorials
35+
36+
[AI Agent Dev School](https://www.youtube.com/watch?v=ArptLpQiKfI&list=PLx5pnFXdPTRzWla0RaOxALTSTnVq53fKL)
37+
38+
## 🎯 Use Cases
39+
40+
- 🤖 Chatbots
41+
- 🕵️ Autonomous Agents
42+
- 📈 Business Process Handling
43+
- 🎮 Video Game NPCs
44+
- 🧠 Trading
45+
46+
## 🚀 Quick Start
47+
48+
### Prerequisites
49+
50+
- [Python 2.7+](https://www.python.org/downloads/)
51+
- [Node.js 23+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
52+
- [pnpm](https://pnpm.io/installation)
53+
54+
> **Note for Windows Users:** [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install-manual) is required.
55+
56+
### Use the Starter (Recommended)
57+
58+
```bash
59+
git clone https://github.com/elizaos/eliza-starter.git
60+
cd eliza-starter
61+
cp .env.example .env
62+
pnpm i && pnpm build && pnpm start
63+
```
64+
65+
Once the agent is running, you should see the message to run "pnpm start:client" at the end.
66+
Open another terminal and move to same directory and then run below command and follow the URL to chat to your agent.
67+
68+
```bash
69+
pnpm start:client
70+
```
71+
72+
Then read the [Documentation](https://elizaos.github.io/eliza/) to learn how to customize your Eliza.
73+
74+
### Manually Start Eliza (Only recommended if you know what you are doing)
75+
76+
```bash
77+
# Clone the repository
78+
git clone https://github.com/elizaos/eliza.git
79+
80+
# Checkout the latest release
81+
# This project iterates fast, so we recommend checking out the latest release
82+
git checkout $(git describe --tags --abbrev=0)
83+
```
84+
85+
### Start Eliza with Gitpod
86+
87+
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/elizaos/eliza/tree/main)
88+
89+
### Edit the .env file
90+
91+
Copy .env.example to .env and fill in the appropriate values.
92+
93+
```
94+
cp .env.example .env
95+
```
96+
97+
Note: .env is optional. If you're planning to run multiple distinct agents, you can pass secrets through the character JSON
98+
Note: .env is optional. If you're planning to run multiple distinct agents, you can pass secrets through the character JSON
99+
100+
### Automatically Start Eliza
101+
102+
This will run everything to set up the project and start the bot with the default character.
103+
104+
```bash
105+
sh scripts/start.sh
106+
```
107+
108+
### Edit the character file
109+
110+
1. Open `packages/core/src/defaultCharacter.ts` to modify the default character. Uncomment and edit.
111+
112+
2. To load custom characters:
113+
- Use `pnpm start --characters="path/to/your/character.json"`
114+
- Multiple character files can be loaded simultaneously
115+
3. Connect with X (Twitter)
116+
- change `"clients": []` to `"clients": ["twitter"]` in the character file to connect with X
117+
118+
### Manually Start Eliza
119+
120+
```bash
121+
pnpm i
122+
pnpm build
123+
pnpm start
124+
125+
# The project iterates fast, sometimes you need to clean the project if you are coming back to the project
126+
pnpm clean
127+
```
128+
129+
#### Additional Requirements
130+
131+
You may need to install Sharp. If you see an error when starting up, try installing it with the following command:
132+
133+
```
134+
pnpm install --include=optional sharp
135+
```
136+
137+
### Community & contact
138+
139+
- [GitHub Issues](https://github.com/elizaos/eliza/issues). Best for: bugs you encounter using Eliza, and feature proposals.
140+
- [Discord](https://discord.gg/ai16z). Best for: sharing your applications and hanging out with the community.
141+
142+
## Contributors
143+
144+
<a href="https://github.com/elizaos/eliza/graphs/contributors">
145+
<img src="https://contrib.rocks/image?repo=elizaos/eliza" />
146+
</a>
147+
148+
## Star History
149+
150+
[![Star History Chart](https://api.star-history.com/svg?repos=elizaos/eliza&type=Date)](https://star-history.com/#elizaos/eliza&Date)

‎README_AR.md

+133
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
# Eliza 🤖
2+
3+
<div align="center">
4+
<img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
5+
</div>
6+
7+
<div align="center">
8+
9+
📖 [التعليمات](https://elizaos.github.io/eliza/) | 🎯 [الأمثلة](https://github.com/thejoven/awesome-eliza)
10+
11+
</div>
12+
13+
## ✨ ما هي الميزات؟
14+
15+
- 🛠️ اتصالات مجهزة بالكامل لديسكورد، تويتر، وتيليغرام.
16+
- 👥 دعم متعدد للوكلاء والغرف.
17+
- 📚 التفاعل بإتقان مع المستندات كما يمكن فحصها بسهولة.
18+
- 💾 ذاكرة قوية قابلة لاسترجاع ما فاتك! وكذلك مساحة كافية للتخزين
19+
- 🚀 سريعة الانتشار بشكل غير مسبوق، هيّا! تفاعل واصنع عملاء خاصين بك.
20+
- ☁️ تدعم العديد من النماذج مثل:-
21+
- لاما (نموذج مفتوح المصدر للذكاء الاصطناعي Llama).
22+
- جروك (نظام ذكاء اصطناعي متقدم Grok).
23+
- أوبن إيه آي (OpenAI نماذج ذكاء اصطناعي مثل ChatGPT).
24+
- أنثروبيك Anthropic وغيرها من النماذج الأخرى!
25+
- 📦 جاهزة للعمل أي وقت وبسهولة!
26+
27+
## 🎯 كيف ستفيدني؟
28+
29+
- 🤖 روبوتات الدردشة.
30+
- 🕵️ وكلاء مستقلون.
31+
- 📈 إدارة الأعمال.
32+
- 🎮 في الجيميز NPCs أو الشخصيات التي يتحكم بها الحاسوب فقط وليس اللاعب.
33+
- 🧠 التداول.
34+
35+
## 🚀 ابدأ الآن!
36+
37+
### ماذا عن المتطلبات الأساسية؟
38+
39+
- [Python 2.7+](https://www.python.org/downloads/)
40+
- [Node.js 23+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
41+
- [pnpm](https://pnpm.io/installation)
42+
43+
> **لمتسخدمي الويندوز يجب أن يكون لديك نظام ويندوز الفرعي للينكس:** [WSL 2](https://learn.microsoft.com/de-de/windows/wsl/install-manual).
44+
45+
### استخدام النسخة المبدئية (موصى به)
46+
47+
```bash
48+
git clone https://github.com/elizaos/eliza-starter.git
49+
50+
cp .env.example .env
51+
52+
pnpm i && pnpm start
53+
```
54+
55+
تعلم أكثر عن كيفية تخصيص إليزا من هنا [التعليمات](https://elizaos.github.io/eliza/)
56+
57+
### إذا كان لديك خبرة بالفعل، يُمكنك تشغيل إليزا يدويًا.
58+
59+
```bash
60+
# انشئ نسخة
61+
git clone https://github.com/elizaos/eliza.git
62+
63+
# ألق نظرة على آخر تحديث
64+
# هذا المشروع يتطور بسرعة، لذا، أوصيك باستخدام أحدث إصدار
65+
git checkout $(git describe --tags --abbrev=0)
66+
```
67+
68+
### تشغل إليزا مع Gitpod
69+
70+
[![In Gitpod öffnen](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/elizaos/eliza/tree/main)
71+
72+
### عدّل ملف .env-Datei
73+
74+
انسخ ملف .env.example إلى .env واملأ القيم المناسبة.
75+
76+
```
77+
cp .env.example .env
78+
```
79+
80+
ضع في الإعتبار أن ملف .env اختياري. إذا كنت تخطط لتشغيل عدة وكلاء مختلفين، ابعت الـsecrets من خلال ملف JSON الخاص بالشخصية.
81+
82+
### تشغيل إليزا تلقائيًا
83+
84+
هذا الكود لتنفيذ جميع الخطوات اللازمة لإعداد المشروع وكذلك تشغيل الروبوت مع الشخصية الافتراضية.
85+
86+
```bash
87+
sh scripts/start.sh
88+
```
89+
90+
### لتعديل ملف الشخصية
91+
92+
افتح ملف agent/src/character.ts لتعديل الشخصية الافتراضية. قم بإلغاء التعليق وعدّل عليها.
93+
94+
لتحميل شخصيات مخصصة
95+
- استخدم الأمر "pnpm start --characters="path/to/your/character.json
96+
- يُمكنك تحميل عدة ملفات للشخصيات في نفس الوقت.
97+
98+
الاتصال بـ X (تويتر):
99+
- غيّر "clients": [] إلى "clients": ["twitter"] في ملف الشخصية للاتصال بـ X أو تويتر
100+
101+
### لتشغيل إليزا يدويًا
102+
103+
```bash
104+
pnpm i
105+
pnpm build
106+
pnpm start
107+
108+
# المشروع يتطور سريعًا. لذا قد تحتاج إلى تنظيف المشروع إذا قمت بالرجوع إليه بعد فترة.
109+
pnpm clean
110+
```
111+
112+
#### المتطلبات الإضافية
113+
114+
قد تحتاج إلى تثبيت Sharp. إذا واجهت خطأ أثناء بدء التشغيل، جرب استخدام الأمر التالي:
115+
116+
```
117+
pnpm install --include=optional sharp
118+
```
119+
120+
### المجتمع والدعم
121+
122+
- في حال إذا واجهت أي مشاكل تتعلق باستخدام إليزا ولتقديم المقترحات [GitHub Issues](https://github.com/elizaos/eliza/issues).
123+
- لمشاركة تطبيقاتك والتفاعل مع المجتمع [Discord](https://discord.gg/ai16z).
124+
125+
## المُساهمون
126+
127+
<a href="https://github.com/elizaos/eliza/graphs/contributors">
128+
<img src="https://contrib.rocks/image?repo=elizaos/eliza" />
129+
</a>
130+
131+
## تاريخ النجوم
132+
133+
[![Star History Chart](https://api.star-history.com/svg?repos=elizaos/eliza&type=Date)](https://star-history.com/#elizaos/eliza&Date)

0 commit comments

Comments
 (0)