Skip to content

Commit 15fd596

Browse files
matthewhou19matthewhou19
committed
Added a development approach for Windows Users
As a Windows user unfamiliar with WSL development, it took me hours to successfully set up the environment. Therefore, I suggest including an additional approach specifically tailored for Windows developers like me. I believe this would significantly reduce the time and effort required for others in a similar situation.
1 parent 76d4f42 commit 15fd596

File tree

1 file changed

+149
-141
lines changed

1 file changed

+149
-141
lines changed

‎README.md

+149-141
Original file line numberDiff line numberDiff line change
@@ -1,141 +1,149 @@
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)
16-
17-
## ✨ Features
18-
19-
- 🛠️ Full-featured Discord, Twitter and Telegram connectors
20-
- 🔗 Support for every model (Llama, Grok, OpenAI, Anthropic, etc.)
21-
- 👥 Multi-agent and room support
22-
- 📚 Easily ingest and interact with your documents
23-
- 💾 Retrievable memory and document store
24-
- 🚀 Highly extensible - create your own actions and clients
25-
- ☁️ Supports many models (local Llama, OpenAI, Anthropic, Groq, etc.)
26-
- 📦 Just works!
27-
28-
## Video Tutorials
29-
30-
[AI Agent Dev School](https://www.youtube.com/watch?v=ArptLpQiKfI&list=PLx5pnFXdPTRzWla0RaOxALTSTnVq53fKL)
31-
32-
## 🎯 Use Cases
33-
34-
- 🤖 Chatbots
35-
- 🕵️ Autonomous Agents
36-
- 📈 Business Process Handling
37-
- 🎮 Video Game NPCs
38-
- 🧠 Trading
39-
40-
## 🚀 Quick Start
41-
42-
### Prerequisites
43-
44-
- [Python 2.7+](https://www.python.org/downloads/)
45-
- [Node.js 23+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
46-
- [pnpm](https://pnpm.io/installation)
47-
48-
> **Note for Windows Users:** [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install-manual) is required.
49-
50-
### Use the Starter (Recommended)
51-
52-
```bash
53-
git clone https://github.com/elizaos/eliza-starter.git
54-
cd eliza-starter
55-
cp .env.example .env
56-
pnpm i && pnpm build && pnpm start
57-
```
58-
Once the agent is running, You should see the message to run "pnpm start:client" at the end.
59-
Open another terminal and move to same directory and then run below command and follow the URL to chat to your agent.
60-
```bash
61-
pnpm start:client
62-
```
63-
64-
Then read the [Documentation](https://elizaos.github.io/eliza/) to learn how to customize your Eliza.
65-
66-
### Manually Start Eliza (Only recommended if you know what you are doing)
67-
68-
```bash
69-
# Clone the repository
70-
git clone https://github.com/elizaos/eliza.git
71-
72-
# Checkout the latest release
73-
# This project iterates fast, so we recommend checking out the latest release
74-
git checkout $(git describe --tags --abbrev=0)
75-
```
76-
77-
### Start Eliza with Gitpod
78-
79-
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/elizaos/eliza/tree/main)
80-
81-
### Edit the .env file
82-
83-
Copy .env.example to .env and fill in the appropriate values.
84-
85-
```
86-
cp .env.example .env
87-
```
88-
89-
Note: .env is optional. If your planning to run multiple distinct agents, you can pass secrets through the character JSON
90-
91-
### Automatically Start Eliza
92-
93-
This will run everything to setup the project and start the bot with the default character.
94-
95-
```bash
96-
sh scripts/start.sh
97-
```
98-
99-
### Edit the character file
100-
101-
1. Open `packages/core/src/defaultCharacter.ts` to modify the default character. Uncomment and edit.
102-
103-
2. To load custom characters:
104-
- Use `pnpm start --characters="path/to/your/character.json"`
105-
- Multiple character files can be loaded simultaneously
106-
3. Connect with X (Twitter)
107-
- change `"clients": []` to `"clients": ["twitter"]` in the character file to connect with X
108-
109-
### Manually Start Eliza
110-
111-
```bash
112-
pnpm i
113-
pnpm build
114-
pnpm start
115-
116-
# The project iterates fast, sometimes you need to clean the project if you are coming back to the project
117-
pnpm clean
118-
```
119-
120-
#### Additional Requirements
121-
122-
You may need to install Sharp. If you see an error when starting up, try installing it with the following command:
123-
124-
```
125-
pnpm install --include=optional sharp
126-
```
127-
128-
### Community & contact
129-
130-
- [GitHub Issues](https://github.com/elizaos/eliza/issues). Best for: bugs you encounter using Eliza, and feature proposals.
131-
- [Discord](https://discord.gg/ai16z). Best for: sharing your applications and hanging out with the community.
132-
133-
## Contributors
134-
135-
<a href="https://github.com/elizaos/eliza/graphs/contributors">
136-
<img src="https://contrib.rocks/image?repo=elizaos/eliza" />
137-
</a>
138-
139-
## Star History
140-
141-
[![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)
16+
17+
## ✨ Features
18+
19+
- 🛠️ Full-featured Discord, Twitter and Telegram connectors
20+
- 🔗 Support for every model (Llama, Grok, OpenAI, Anthropic, etc.)
21+
- 👥 Multi-agent and room support
22+
- 📚 Easily ingest and interact with your documents
23+
- 💾 Retrievable memory and document store
24+
- 🚀 Highly extensible - create your own actions and clients
25+
- ☁️ Supports many models (local Llama, OpenAI, Anthropic, Groq, etc.)
26+
- 📦 Just works!
27+
28+
## Video Tutorials
29+
30+
[AI Agent Dev School](https://www.youtube.com/watch?v=ArptLpQiKfI&list=PLx5pnFXdPTRzWla0RaOxALTSTnVq53fKL)
31+
32+
## 🎯 Use Cases
33+
34+
- 🤖 Chatbots
35+
- 🕵️ Autonomous Agents
36+
- 📈 Business Process Handling
37+
- 🎮 Video Game NPCs
38+
- 🧠 Trading
39+
40+
## 🚀 Quick Start
41+
42+
### Prerequisites
43+
44+
- [Python 2.7+](https://www.python.org/downloads/)
45+
- [Node.js 23+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
46+
- [pnpm](https://pnpm.io/installation)
47+
48+
> **Note for Windows Users:** [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install-manual) is required.
49+
50+
### For Windows Users (Optional)
51+
52+
* Install the Remote Development extension in Visual Studio.
53+
* Press **F1** in Visual Studio, type **"Remote"** , and select **Remote Explorer: Focus on WSL Targets View** .
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+
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+
67+
```bash
68+
pnpm start:client
69+
```
70+
71+
Then read the [Documentation](https://elizaos.github.io/eliza/) to learn how to customize your Eliza.
72+
73+
### Manually Start Eliza (Only recommended if you know what you are doing)
74+
75+
```bash
76+
# Clone the repository
77+
git clone https://github.com/elizaos/eliza.git
78+
79+
# Checkout the latest release
80+
# This project iterates fast, so we recommend checking out the latest release
81+
git checkout $(git describe --tags --abbrev=0)
82+
```
83+
84+
### Start Eliza with Gitpod
85+
86+
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/elizaos/eliza/tree/main)
87+
88+
### Edit the .env file
89+
90+
Copy .env.example to .env and fill in the appropriate values.
91+
92+
```
93+
cp .env.example .env
94+
```
95+
96+
Note: .env is optional. If your planning to run multiple distinct agents, you can pass secrets through the character JSON
97+
98+
### Automatically Start Eliza
99+
100+
This will run everything to setup the project and start the bot with the default character.
101+
102+
```bash
103+
sh scripts/start.sh
104+
```
105+
106+
### Edit the character file
107+
108+
1. Open `packages/core/src/defaultCharacter.ts` to modify the default character. Uncomment and edit.
109+
2. To load custom characters:
110+
111+
- Use `pnpm start --characters="path/to/your/character.json"`
112+
- Multiple character files can be loaded simultaneously
113+
3. Connect with X (Twitter)
114+
115+
- change `"clients": []` to `"clients": ["twitter"]` in the character file to connect with X
116+
117+
### Manually Start Eliza
118+
119+
```bash
120+
pnpm i
121+
pnpm build
122+
pnpm start
123+
124+
# The project iterates fast, sometimes you need to clean the project if you are coming back to the project
125+
pnpm clean
126+
```
127+
128+
#### Additional Requirements
129+
130+
You may need to install Sharp. If you see an error when starting up, try installing it with the following command:
131+
132+
```
133+
pnpm install --include=optional sharp
134+
```
135+
136+
### Community & contact
137+
138+
- [GitHub Issues](https://github.com/elizaos/eliza/issues). Best for: bugs you encounter using Eliza, and feature proposals.
139+
- [Discord](https://discord.gg/ai16z). Best for: sharing your applications and hanging out with the community.
140+
141+
## Contributors
142+
143+
<a href="https://github.com/elizaos/eliza/graphs/contributors">
144+
<img src="https://contrib.rocks/image?repo=elizaos/eliza" />
145+
</a>
146+
147+
## Star History
148+
149+
[![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)