Skip to content

Commit 4de1ea0

Browse files
author
mike dupont
committed
update readme and bootscript
1 parent 9531466 commit 4de1ea0

File tree

2 files changed

+169
-167
lines changed

2 files changed

+169
-167
lines changed

‎README.md

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

‎akash_boot.sh

+6
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
11
#to run this
22
# curl https://raw.githubusercontent.com/meta-introspector/cloud-deployment-eliza/refs/heads/feature/akash_docker/akash_boot.sh | bash
33

4+
# akash runs like this>
5+
#bash -c "curl https://raw.githubusercontent.com/meta-introspector/cloud-deployment-eliza/refs/heads/feature/akash_docker/akash_boot.sh | bash"
6+
7+
cd /app
8+
9+
pnpm start:debug --characters=./characters/eliza.character.json

0 commit comments

Comments
 (0)