Skip to content

Commit aa8700c

Browse files
sunsakissunsakis
committed
added original README
1 parent 44a77be commit aa8700c

File tree

1 file changed

+168
-168
lines changed

1 file changed

+168
-168
lines changed

‎README.md

+168-168
Original file line numberDiff line numberDiff line change
@@ -1,168 +1,168 @@
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-
[中文说明](i18n/readme/README_CN.md) | [日本語の説明](i18n/readme/README_JA.md) | [한국어 설명](i18n/readme/README_KOR.md) | [Persian](i18n/readme/README_FA.md) | [Français](i18n/readme/README_FR.md) | [Português](i18n/readme/README_PTBR.md) | [Türkçe](i18n/readme/README_TR.md) | [Русский](i18n/readme/README_RU.md) | [Español](i18n/readme/README_ES.md) | [Italiano](i18n/readme/README_IT.md) | [ไทย](i18n/readme/README_TH.md) | [Deutsch](i18n/readme/README_DE.md) | [Tiếng Việt](i18n/readme/README_VI.md) | [עִברִית](i18n/readme/README_HE.md) | [Tagalog](i18n/readme/README_TG.md) | [Polski](i18n/readme/README_PL.md) | [Arabic](i18n/readme/README_AR.md) | [Hungarian](i18n/readme/README_HU.md) | [Srpski](i18n/readme/README_RS.md) | [Română](i18n/readme/README_RO.md) | [Nederlands](i18n/readme/README_NL.md) | [Ελληνικά](i18n/readme/README_GR.md)
16-
17-
## 🚩 Overview
18-
19-
<div align="center">
20-
<img src="./docs/static/img/eliza_diagram.png" 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, Gemini, 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-
- 📦 Just works!
32-
33-
## Video Tutorials
34-
35-
[AI Agent Dev School](https://www.youtube.com/watch?v=ArptLpQiKfI&list=PLx5pnFXdPTRzWla0RaOxALTSTnVq53fKL)
36-
37-
## 🎯 Use Cases
38-
39-
- 🤖 Chatbots
40-
- 🕵️ Autonomous Agents
41-
- 📈 Business Process Handling
42-
- 🎮 Video Game NPCs
43-
- 🧠 Trading
44-
45-
## 🚀 Quick Start
46-
47-
### Prerequisites
48-
49-
- [Python 2.7+](https://www.python.org/downloads/)
50-
- [Node.js 23+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
51-
- [pnpm](https://pnpm.io/installation)
52-
53-
> **Note for Windows Users:** [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install-manual) is required.
54-
55-
### Use the Starter (Recommended)
56-
57-
```bash
58-
git clone https://github.com/elizaos/eliza-starter.git
59-
cd eliza-starter
60-
cp .env.example .env
61-
pnpm i && pnpm build && pnpm start
62-
```
63-
64-
### Manually Start Eliza (Only recommended if you know what you are doing)
65-
66-
#### Checkout the latest release
67-
68-
```bash
69-
# Clone the repository
70-
git clone https://github.com/elizaos/eliza.git
71-
72-
# This project iterates fast, so we recommend checking out the latest release
73-
git checkout $(git describe --tags --abbrev=0)
74-
# If the above doesn't checkout the latest release, this should work:
75-
# git checkout $(git describe --tags `git rev-list --tags --max-count=1`)
76-
```
77-
78-
#### Edit the .env file
79-
80-
Copy .env.example to .env and fill in the appropriate values.
81-
82-
```
83-
cp .env.example .env
84-
```
85-
86-
Note: .env is optional. If you're planning to run multiple distinct agents, you can pass secrets through the character JSON
87-
88-
#### Start Eliza
89-
90-
```bash
91-
pnpm i
92-
pnpm build
93-
pnpm start
94-
95-
# The project iterates fast, sometimes you need to clean the project if you are coming back to the project
96-
pnpm clean
97-
```
98-
99-
### Interact via Browser
100-
101-
Once the agent is running, you should see the message to run "pnpm start:client" at the end.
102-
103-
Open another terminal, move to same directory, run the command below, then follow the URL to chat with your agent.
104-
105-
```bash
106-
pnpm start:client
107-
```
108-
109-
Then read the [Documentation](https://elizaos.github.io/eliza/) to learn how to customize your Eliza.
110-
111-
---
112-
113-
### Automatically Start Eliza
114-
115-
The start script provides an automated way to set up and run Eliza:
116-
117-
```bash
118-
sh scripts/start.sh
119-
```
120-
121-
For detailed instructions on using the start script, including character management and troubleshooting, see our [Start Script Guide](./docs/docs/guides/start-script.md).
122-
123-
> **Note**: The start script handles all dependencies, environment setup, and character management automatically.
124-
125-
---
126-
127-
### Modify Character
128-
129-
1. Open `packages/core/src/defaultCharacter.ts` to modify the default character. Uncomment and edit.
130-
131-
2. To load custom characters:
132-
- Use `pnpm start --characters="path/to/your/character.json"`
133-
- Multiple character files can be loaded simultaneously
134-
3. Connect with X (Twitter)
135-
- change `"clients": []` to `"clients": ["twitter"]` in the character file to connect with X
136-
137-
---
138-
139-
#### Additional Requirements
140-
141-
You may need to install Sharp. If you see an error when starting up, try installing it with the following command:
142-
143-
```
144-
pnpm install --include=optional sharp
145-
```
146-
147-
---
148-
149-
### Start Eliza with Gitpod
150-
151-
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/elizaos/eliza/tree/main)
152-
153-
---
154-
155-
### Community & contact
156-
157-
- [GitHub Issues](https://github.com/elizaos/eliza/issues). Best for: bugs you encounter using Eliza, and feature proposals.
158-
- [Discord](https://discord.gg/ai16z). Best for: sharing your applications and hanging out with the community.
159-
160-
## Contributors
161-
162-
<a href="https://github.com/elizaos/eliza/graphs/contributors">
163-
<img src="https://contrib.rocks/image?repo=elizaos/eliza" />
164-
</a>
165-
166-
## Star History
167-
168-
[![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+
[中文说明](i18n/readme/README_CN.md) | [日本語の説明](i18n/readme/README_JA.md) | [한국어 설명](i18n/readme/README_KOR.md) | [Persian](i18n/readme/README_FA.md) | [Français](i18n/readme/README_FR.md) | [Português](i18n/readme/README_PTBR.md) | [Türkçe](i18n/readme/README_TR.md) | [Русский](i18n/readme/README_RU.md) | [Español](i18n/readme/README_ES.md) | [Italiano](i18n/readme/README_IT.md) | [ไทย](i18n/readme/README_TH.md) | [Deutsch](i18n/readme/README_DE.md) | [Tiếng Việt](i18n/readme/README_VI.md) | [עִברִית](i18n/readme/README_HE.md) | [Tagalog](i18n/readme/README_TG.md) | [Polski](i18n/readme/README_PL.md) | [Arabic](i18n/readme/README_AR.md) | [Hungarian](i18n/readme/README_HU.md) | [Srpski](i18n/readme/README_RS.md) | [Română](i18n/readme/README_RO.md) | [Nederlands](i18n/readme/README_NL.md) | [Ελληνικά](i18n/readme/README_GR.md)
16+
17+
## 🚩 Overview
18+
19+
<div align="center">
20+
<img src="./docs/static/img/eliza_diagram.png" 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, Gemini, 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+
- 📦 Just works!
32+
33+
## Video Tutorials
34+
35+
[AI Agent Dev School](https://www.youtube.com/watch?v=ArptLpQiKfI&list=PLx5pnFXdPTRzWla0RaOxALTSTnVq53fKL)
36+
37+
## 🎯 Use Cases
38+
39+
- 🤖 Chatbots
40+
- 🕵️ Autonomous Agents
41+
- 📈 Business Process Handling
42+
- 🎮 Video Game NPCs
43+
- 🧠 Trading
44+
45+
## 🚀 Quick Start
46+
47+
### Prerequisites
48+
49+
- [Python 2.7+](https://www.python.org/downloads/)
50+
- [Node.js 23+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
51+
- [pnpm](https://pnpm.io/installation)
52+
53+
> **Note for Windows Users:** [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install-manual) is required.
54+
55+
### Use the Starter (Recommended)
56+
57+
```bash
58+
git clone https://github.com/elizaos/eliza-starter.git
59+
cd eliza-starter
60+
cp .env.example .env
61+
pnpm i && pnpm build && pnpm start
62+
```
63+
64+
### Manually Start Eliza (Only recommended if you know what you are doing)
65+
66+
#### Checkout the latest release
67+
68+
```bash
69+
# Clone the repository
70+
git clone https://github.com/elizaos/eliza.git
71+
72+
# This project iterates fast, so we recommend checking out the latest release
73+
git checkout $(git describe --tags --abbrev=0)
74+
# If the above doesn't checkout the latest release, this should work:
75+
# git checkout $(git describe --tags `git rev-list --tags --max-count=1`)
76+
```
77+
78+
#### Edit the .env file
79+
80+
Copy .env.example to .env and fill in the appropriate values.
81+
82+
```
83+
cp .env.example .env
84+
```
85+
86+
Note: .env is optional. If you're planning to run multiple distinct agents, you can pass secrets through the character JSON
87+
88+
#### Start Eliza
89+
90+
```bash
91+
pnpm i
92+
pnpm build
93+
pnpm start
94+
95+
# The project iterates fast, sometimes you need to clean the project if you are coming back to the project
96+
pnpm clean
97+
```
98+
99+
### Interact via Browser
100+
101+
Once the agent is running, you should see the message to run "pnpm start:client" at the end.
102+
103+
Open another terminal, move to same directory, run the command below, then follow the URL to chat with your agent.
104+
105+
```bash
106+
pnpm start:client
107+
```
108+
109+
Then read the [Documentation](https://elizaos.github.io/eliza/) to learn how to customize your Eliza.
110+
111+
---
112+
113+
### Automatically Start Eliza
114+
115+
The start script provides an automated way to set up and run Eliza:
116+
117+
```bash
118+
sh scripts/start.sh
119+
```
120+
121+
For detailed instructions on using the start script, including character management and troubleshooting, see our [Start Script Guide](./docs/docs/guides/start-script.md).
122+
123+
> **Note**: The start script handles all dependencies, environment setup, and character management automatically.
124+
125+
---
126+
127+
### Modify Character
128+
129+
1. Open `packages/core/src/defaultCharacter.ts` to modify the default character. Uncomment and edit.
130+
131+
2. To load custom characters:
132+
- Use `pnpm start --characters="path/to/your/character.json"`
133+
- Multiple character files can be loaded simultaneously
134+
3. Connect with X (Twitter)
135+
- change `"clients": []` to `"clients": ["twitter"]` in the character file to connect with X
136+
137+
---
138+
139+
#### Additional Requirements
140+
141+
You may need to install Sharp. If you see an error when starting up, try installing it with the following command:
142+
143+
```
144+
pnpm install --include=optional sharp
145+
```
146+
147+
---
148+
149+
### Start Eliza with Gitpod
150+
151+
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/elizaos/eliza/tree/main)
152+
153+
---
154+
155+
### Community & contact
156+
157+
- [GitHub Issues](https://github.com/elizaos/eliza/issues). Best for: bugs you encounter using Eliza, and feature proposals.
158+
- [Discord](https://discord.gg/ai16z). Best for: sharing your applications and hanging out with the community.
159+
160+
## Contributors
161+
162+
<a href="https://github.com/elizaos/eliza/graphs/contributors">
163+
<img src="https://contrib.rocks/image?repo=elizaos/eliza" />
164+
</a>
165+
166+
## Star History
167+
168+
[![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)