Skip to content

Commit 6b5fc84

Browse files
madjinmadjin
authored
Merge branch 'develop' into feature/full-plugin-docs
2 parents b6100ea + b54fc68 commit 6b5fc84

File tree

41 files changed

+1456
-766
lines changed

Some content is hidden

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

41 files changed

+1456
-766
lines changed

‎.env.example

+1-4
Original file line numberDiff line numberDiff line change
@@ -212,9 +212,6 @@ TOGETHER_API_KEY=
212212
# Server Configuration
213213
SERVER_PORT=3000
214214

215-
# Web Search Config
216-
ENABLE_WEBSEARCH=false # boolean value, defaults to false
217-
218215
# Abstract Configuration
219216
ABSTRACT_ADDRESS=
220217
ABSTRACT_PRIVATE_KEY=
@@ -356,7 +353,7 @@ AWS_S3_UPLOAD_PATH=
356353
DEEPGRAM_API_KEY=
357354

358355
# Sui
359-
SUI_PRIVATE_KEY= # Sui Mnemonic Seed Phrase (`sui keytool generate ed25519`)
356+
SUI_PRIVATE_KEY= # Sui Mnemonic Seed Phrase (`sui keytool generate ed25519`) , Also support `suiprivatekeyxxxx` (sui keytool export --key-identity 0x63)
360357
SUI_NETWORK= # must be one of mainnet, testnet, devnet, localnet
361358

362359
# Story

‎CHANGELOG.md

+142-3
Large diffs are not rendered by default.

‎README.md

+150-147
Original file line numberDiff line numberDiff line change
@@ -1,147 +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)
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-
Once the agent is running, You should see the message to run "pnpm start:client" at the end.
65-
Open another terminal and move to same directory and then run below command and follow the URL to chat to your agent.
66-
```bash
67-
pnpm start:client
68-
```
69-
70-
Then read the [Documentation](https://elizaos.github.io/eliza/) to learn how to customize your Eliza.
71-
72-
### Manually Start Eliza (Only recommended if you know what you are doing)
73-
74-
```bash
75-
# Clone the repository
76-
git clone https://github.com/elizaos/eliza.git
77-
78-
# Checkout the latest release
79-
# This project iterates fast, so we recommend checking out the latest release
80-
git checkout $(git describe --tags --abbrev=0)
81-
```
82-
83-
### Start Eliza with Gitpod
84-
85-
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/elizaos/eliza/tree/main)
86-
87-
### Edit the .env file
88-
89-
Copy .env.example to .env and fill in the appropriate values.
90-
91-
```
92-
cp .env.example .env
93-
```
94-
95-
Note: .env is optional. If you're planning to run multiple distinct agents, you can pass secrets through the character JSON
96-
97-
### Automatically Start Eliza
98-
99-
This will run everything to set up the project and start the bot with the default character.
100-
101-
```bash
102-
sh scripts/start.sh
103-
```
104-
105-
### Edit the character file
106-
107-
1. Open `packages/core/src/defaultCharacter.ts` to modify the default character. Uncomment and edit.
108-
109-
2. To load custom characters:
110-
- Use `pnpm start --characters="path/to/your/character.json"`
111-
- Multiple character files can be loaded simultaneously
112-
3. Connect with X (Twitter)
113-
- change `"clients": []` to `"clients": ["twitter"]` in the character file to connect with X
114-
115-
### Manually Start Eliza
116-
117-
```bash
118-
pnpm i
119-
pnpm build
120-
pnpm start
121-
122-
# The project iterates fast, sometimes you need to clean the project if you are coming back to the project
123-
pnpm clean
124-
```
125-
126-
#### Additional Requirements
127-
128-
You may need to install Sharp. If you see an error when starting up, try installing it with the following command:
129-
130-
```
131-
pnpm install --include=optional sharp
132-
```
133-
134-
### Community & contact
135-
136-
- [GitHub Issues](https://github.com/elizaos/eliza/issues). Best for: bugs you encounter using Eliza, and feature proposals.
137-
- [Discord](https://discord.gg/ai16z). Best for: sharing your applications and hanging out with the community.
138-
139-
## Contributors
140-
141-
<a href="https://github.com/elizaos/eliza/graphs/contributors">
142-
<img src="https://contrib.rocks/image?repo=elizaos/eliza" />
143-
</a>
144-
145-
## Star History
146-
147-
[![Star History Chart](https://api.star-history.com/svg?repos=elizaos/eliza&type=Date)](https://star-history.com/#elizaos/eliza&Date)
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)
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_KOR.md

+26-18
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,18 @@
1212

1313
## ✨ 기능
1414

15-
- 🛠 SNS 지원: 디스코드, 트위터, 텔레그램 모두 지원됩니다.
16-
- 🔗 다양한 모델 지원 (Llama, Grok, OpenAI, Anthropic 등)
17-
- 👥 다중 지원: 다중 에이전트 및 채팅방이 지원됩니다.
18-
- 📚 높은 유연성: 개발자가 쉽게 데이터를 추가하고, 이를 활용해 다양한 기능을 만들 수 있습니다.
19-
- 💾 검색 지원: 당신의 데이터와 작업을 쉽게 찾아볼 수 있도록, 검색 기능을 지원합니다.
20-
- 🚀 높은 확장성: 자신의 동작과 클라이언트를 만들어 기능을 확장할 수 있습니다.
21-
- ☁️ 다양한 AI 모델 지원: local Llama, OpenAI, Anthropic, Groq 등 다양한 AI 모델을 지원합니다
22-
- 📦 즐겁게 개발해 봐요!
15+
- 🛠 SNS 통합 지원: Discord, Twitter, Telegram을 모두 지원합니다.
16+
- 🔗 다양한 모델 호환: Llama, Grok, OpenAI, Anthropic 등 다양한 AI 모델을 지원합니다.
17+
- 👥 다중 에이전트 및 채팅방 지원: 여러 에이전트와 채팅방을 손쉽게 관리할 수 있습니다.
18+
- 📚 문서 처리 및 상호작용: 데이터를 손쉽게 추가하고 활용할 수 있는 기능을 제공합니다.
19+
- 💾 검색 가능한 메모리 및 문서 저장소: 데이터를 빠르고 간편하게 검색하고 액세스할 수 있습니다.
20+
- 🚀 높은 확장성: 사용자 정의 동작 및 클라이언트를 만들어 기능을 확장할 수 있습니다.
21+
- ☁️ 다양한 AI 모델 지원: Local Llama, OpenAI, Anthropic, Groq 등과 호환됩니다.
22+
- 📦 쉽게 시작하세요: 바로 작동하며 손쉽게 활용할 수 있습니다!
23+
24+
## 비디오 튜토리얼
25+
26+
[AI Agent Dev School](https://www.youtube.com/watch?v=ArptLpQiKfI&list=PLx5pnFXdPTRzWla0RaOxALTSTnVq53fKL)
2327

2428
## 🎯 eliza로 어떤걸 만들 수 있을까요?
2529

@@ -37,21 +41,25 @@
3741
- [Node.js 23.3+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
3842
- [pnpm](https://pnpm.io/installation)
3943

40-
> **Windows 사용자 참고:** [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install-manual) 필요.
44+
> **Windows 사용자 참고:** [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install-manual)가 필요합니다.
4145
4246
### Starter 사용 (권장)
4347

4448
```bash
4549
git clone https://github.com/elizaos/eliza-starter.git
46-
50+
cd eliza-starter
4751
cp .env.example .env
48-
49-
pnpm i && pnpm start
52+
pnpm i && pnpm build && pnpm start
53+
```
54+
에이전트가 실행되면 마지막에 "pnpm start:client"를 실행하라는 메시지가 표시됩니다.
55+
다른 터미널을 열고 같은 디렉토리로 이동한 뒤 아래 명령어를 실행하세요. 표시된 URL을 열어 에이전트와 대화하세요.
56+
```bash
57+
pnpm start:client
5058
```
5159

52-
[문서](https://elizaos.github.io/eliza/)를 참고하여 Eliza를 커스마이징 방법을 확인하세요.
60+
[문서](https://elizaos.github.io/eliza/)를 참고하여 Eliza를 커스터마이징하는 방법을 배워보세요.
5361

54-
### 직접 실행하기 (경험자만 권장)
62+
### Eliza를 수동으로 실행하기 (경험자에게만 권장)
5563

5664
```bash
5765
# 리포지토리 클론
@@ -107,16 +115,16 @@ pnpm clean
107115

108116
#### 추가 요구 사항
109117

110-
시작 시 에러가 발생하면 Sharp를 설치해야 할 수 있습니다. 아래 명령어를 사용하여 설치하세요:
118+
시작할 때 오류가 발생하면 Sharp를 설치해야 할 수도 있습니다. 아래 명령어를 실행하여 설치하세요:
111119

112120
```
113121
pnpm install --include=optional sharp
114122
```
115123

116-
### Community & contact
124+
### 커뮤니티 & 문의
117125

118-
- [Github Issues](https://github.com/elizaos/eliza/issues). 용도: Eliza 사용 중 발견된 버그 리포트, 기능 제안.
119-
- [Discord](https://discord.gg/ai16z). 용도: 애플리케이션 공유 및 커뮤니티 활동.
126+
- [Github Issues](https://github.com/elizaos/eliza/issues). liza 사용 중 발견된 버그 보고 및 기능 제안에 적합합니다.
127+
- [Discord](https://discord.gg/ai16z). 애플리케이션 공유 및 커뮤니티와의 소통에 적합합니다.
120128

121129
## 컨트리뷰터
122130

0 commit comments

Comments
 (0)