Skip to content

Commit c0d2235

Browse files
authored
Update README.md
1 parent b411c95 commit c0d2235

File tree

1 file changed

+14
-165
lines changed

1 file changed

+14
-165
lines changed

README.md

+14-165
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,16 @@
1-
<<<<<<< HEAD
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+
214
# Eliza 🤖
315

416
<div align="center">
@@ -148,167 +160,4 @@ pnpm install --include=optional sharp
148160
## Star History
149161

150162
[![Star History Chart](https://api.star-history.com/svg?repos=elizaos/eliza&type=Date)](https://star-history.com/#elizaos/eliza&Date)
151-
=======
152-
# debug
153-
154-
`pnpm start:debug --characters=./characters/eliza.character.json`
155-
156-
start direct client here
157-
158-
```
159-
git clone https://github.com/meta-introspector/eliza-starter.git eliza-starter
160-
cd eliza-starter
161-
git checkout feature/opentelemetry
162-
pnpm start --characters=characters/eliza.character.json`
163-
```
164-
165-
# Eliza 🤖
166-
167-
<div align="center">
168-
<img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
169-
</div>
170-
171-
<div align="center">
172-
173-
📖 [Documentation](https://elizaos.github.io/eliza/) | 🎯 [Examples](https://github.com/thejoven/awesome-eliza)
174-
175-
</div>
176-
177-
## 🌍 README Translations
178-
179-
[中文说明](./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)
180-
181-
## 🚩 Overview
182-
183-
<div align="center">
184-
<img src="./docs/static/img/eliza_diagram.png" alt="Eliza Diagram" width="100%" />
185-
</div>
186-
187-
## ✨ Features
188-
189-
- 🛠️ Full-featured Discord, Twitter and Telegram connectors
190-
- 🔗 Support for every model (Llama, Grok, OpenAI, Anthropic, etc.)
191-
- 👥 Multi-agent and room support
192-
- 📚 Easily ingest and interact with your documents
193-
- 💾 Retrievable memory and document store
194-
- 🚀 Highly extensible - create your own actions and clients
195-
- ☁️ Supports many models (local Llama, OpenAI, Anthropic, Groq, etc.)
196-
- 📦 Just works!
197-
198-
## Video Tutorials
199-
200-
[AI Agent Dev School](https://www.youtube.com/watch?v=ArptLpQiKfI&list=PLx5pnFXdPTRzWla0RaOxALTSTnVq53fKL)
201-
202-
## 🎯 Use Cases
203-
204-
- 🤖 Chatbots
205-
- 🕵️ Autonomous Agents
206-
- 📈 Business Process Handling
207-
- 🎮 Video Game NPCs
208-
- 🧠 Trading
209-
210-
## 🚀 Quick Start
211-
212-
### Prerequisites
213-
214-
- [Python 2.7+](https://www.python.org/downloads/)
215-
- [Node.js 23+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
216-
- [pnpm](https://pnpm.io/installation)
217-
218-
> **Note for Windows Users:** [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install-manual) is required.
219-
220-
### Use the Starter (Recommended)
221-
222-
```bash
223-
git clone https://github.com/elizaos/eliza-starter.git
224-
cd eliza-starter
225-
cp .env.example .env
226-
pnpm i && pnpm build && pnpm start
227-
```
228-
229-
Once the agent is running, you should see the message to run "pnpm start:client" at the end.
230-
Open another terminal and move to same directory and then run below command and follow the URL to chat to your agent.
231-
232-
```bash
233-
pnpm start:client
234-
```
235-
236-
Then read the [Documentation](https://elizaos.github.io/eliza/) to learn how to customize your Eliza.
237-
238-
### Manually Start Eliza (Only recommended if you know what you are doing)
239-
240-
```bash
241-
# Clone the repository
242-
git clone https://github.com/elizaos/eliza.git
243-
244-
# Checkout the latest release
245-
# This project iterates fast, so we recommend checking out the latest release
246-
git checkout $(git describe --tags --abbrev=0)
247-
```
248-
249-
### Start Eliza with Gitpod
250-
251-
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/elizaos/eliza/tree/main)
252-
253-
### Edit the .env file
254-
255-
Copy .env.example to .env and fill in the appropriate values.
256-
257-
```
258-
cp .env.example .env
259-
```
260-
261-
Note: .env is optional. If you're planning to run multiple distinct agents, you can pass secrets through the character JSON
262-
263-
### Automatically Start Eliza
264-
265-
This will run everything to set up the project and start the bot with the default character.
266-
267-
```bash
268-
sh scripts/start.sh
269-
```
270-
271-
### Edit the character file
272-
273-
1. Open `packages/core/src/defaultCharacter.ts` to modify the default character. Uncomment and edit.
274-
275-
2. To load custom characters:
276-
- Use `pnpm start --characters="path/to/your/character.json"`
277-
- Multiple character files can be loaded simultaneously
278-
3. Connect with X (Twitter)
279-
- change `"clients": []` to `"clients": ["twitter"]` in the character file to connect with X
280-
281-
### Manually Start Eliza
282-
283-
```bash
284-
pnpm i
285-
pnpm build
286-
pnpm start
287-
288-
# The project iterates fast, sometimes you need to clean the project if you are coming back to the project
289-
pnpm clean
290-
```
291-
292-
#### Additional Requirements
293-
294-
You may need to install Sharp. If you see an error when starting up, try installing it with the following command:
295-
296-
```
297-
pnpm install --include=optional sharp
298-
```
299-
300-
### Community & contact
301-
302-
- [GitHub Issues](https://github.com/elizaos/eliza/issues). Best for: bugs you encounter using Eliza, and feature proposals.
303-
- [Discord](https://discord.gg/ai16z). Best for: sharing your applications and hanging out with the community.
304-
305-
## Contributors
306-
307-
<a href="https://github.com/elizaos/eliza/graphs/contributors">
308-
<img src="https://contrib.rocks/image?repo=elizaos/eliza" />
309-
</a>
310-
311-
## Star History
312-
313-
[![Star History Chart](https://api.star-history.com/svg?repos=elizaos/eliza&type=Date)](https://star-history.com/#elizaos/eliza&Date)
314-
>>>>>>> 83970a8e6 (now running locally)
163+

0 commit comments

Comments
 (0)