-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'develop' into tcm-trimTokens
- Loading branch information
Showing
4 changed files
with
362 additions
and
245 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,150 +1,150 @@ | ||
| # Eliza 🤖 | ||
|
|
||
| <div align="center"> | ||
| <img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" /> | ||
| </div> | ||
|
|
||
| <div align="center"> | ||
|
|
||
| 📖 [Documentation](https://elizaos.github.io/eliza/) | 🎯 [Examples](https://github.com/thejoven/awesome-eliza) | ||
|
|
||
| </div> | ||
|
|
||
| ## 🌍 README Translations | ||
|
|
||
| [中文说明](./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) | ||
|
|
||
| ## 🚩 Overview | ||
|
|
||
| <div align="center"> | ||
| <img src="./docs/static/img/eliza_diagram.jpg" alt="Eliza Diagram" width="100%" /> | ||
| </div> | ||
|
|
||
| ## ✨ Features | ||
|
|
||
| - 🛠️ Full-featured Discord, Twitter and Telegram connectors | ||
| - 🔗 Support for every model (Llama, Grok, OpenAI, Anthropic, etc.) | ||
| - 👥 Multi-agent and room support | ||
| - 📚 Easily ingest and interact with your documents | ||
| - 💾 Retrievable memory and document store | ||
| - 🚀 Highly extensible - create your own actions and clients | ||
| - ☁️ Supports many models (local Llama, OpenAI, Anthropic, Groq, etc.) | ||
| - 📦 Just works! | ||
|
|
||
| ## Video Tutorials | ||
|
|
||
| [AI Agent Dev School](https://www.youtube.com/watch?v=ArptLpQiKfI&list=PLx5pnFXdPTRzWla0RaOxALTSTnVq53fKL) | ||
|
|
||
| ## 🎯 Use Cases | ||
|
|
||
| - 🤖 Chatbots | ||
| - 🕵️ Autonomous Agents | ||
| - 📈 Business Process Handling | ||
| - 🎮 Video Game NPCs | ||
| - 🧠 Trading | ||
|
|
||
| ## 🚀 Quick Start | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| - [Python 2.7+](https://www.python.org/downloads/) | ||
| - [Node.js 23+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) | ||
| - [pnpm](https://pnpm.io/installation) | ||
|
|
||
| > **Note for Windows Users:** [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install-manual) is required. | ||
| ### Use the Starter (Recommended) | ||
|
|
||
| ```bash | ||
| git clone https://github.com/elizaos/eliza-starter.git | ||
| cd eliza-starter | ||
| cp .env.example .env | ||
| pnpm i && pnpm build && pnpm start | ||
| ``` | ||
|
|
||
| Once the agent is running, you should see the message to run "pnpm start:client" at the end. | ||
| Open another terminal and move to same directory and then run below command and follow the URL to chat to your agent. | ||
|
|
||
| ```bash | ||
| pnpm start:client | ||
| ``` | ||
|
|
||
| Then read the [Documentation](https://elizaos.github.io/eliza/) to learn how to customize your Eliza. | ||
|
|
||
| ### Manually Start Eliza (Only recommended if you know what you are doing) | ||
|
|
||
| ```bash | ||
| # Clone the repository | ||
| git clone https://github.com/elizaos/eliza.git | ||
|
|
||
| # Checkout the latest release | ||
| # This project iterates fast, so we recommend checking out the latest release | ||
| git checkout $(git describe --tags --abbrev=0) | ||
| ``` | ||
|
|
||
| ### Start Eliza with Gitpod | ||
|
|
||
| [](https://gitpod.io/#https://github.com/elizaos/eliza/tree/main) | ||
|
|
||
| ### Edit the .env file | ||
|
|
||
| Copy .env.example to .env and fill in the appropriate values. | ||
|
|
||
| ``` | ||
| cp .env.example .env | ||
| ``` | ||
|
|
||
| Note: .env is optional. If you're planning to run multiple distinct agents, you can pass secrets through the character JSON | ||
| Note: .env is optional. If you're planning to run multiple distinct agents, you can pass secrets through the character JSON | ||
|
|
||
| ### Automatically Start Eliza | ||
|
|
||
| This will run everything to set up the project and start the bot with the default character. | ||
|
|
||
| ```bash | ||
| sh scripts/start.sh | ||
| ``` | ||
|
|
||
| ### Edit the character file | ||
|
|
||
| 1. Open `packages/core/src/defaultCharacter.ts` to modify the default character. Uncomment and edit. | ||
|
|
||
| 2. To load custom characters: | ||
| - Use `pnpm start --characters="path/to/your/character.json"` | ||
| - Multiple character files can be loaded simultaneously | ||
| 3. Connect with X (Twitter) | ||
| - change `"clients": []` to `"clients": ["twitter"]` in the character file to connect with X | ||
|
|
||
| ### Manually Start Eliza | ||
|
|
||
| ```bash | ||
| pnpm i | ||
| pnpm build | ||
| pnpm start | ||
|
|
||
| # The project iterates fast, sometimes you need to clean the project if you are coming back to the project | ||
| pnpm clean | ||
| ``` | ||
|
|
||
| #### Additional Requirements | ||
|
|
||
| You may need to install Sharp. If you see an error when starting up, try installing it with the following command: | ||
|
|
||
| ``` | ||
| pnpm install --include=optional sharp | ||
| ``` | ||
|
|
||
| ### Community & contact | ||
|
|
||
| - [GitHub Issues](https://github.com/elizaos/eliza/issues). Best for: bugs you encounter using Eliza, and feature proposals. | ||
| - [Discord](https://discord.gg/ai16z). Best for: sharing your applications and hanging out with the community. | ||
|
|
||
| ## Contributors | ||
|
|
||
| <a href="https://github.com/elizaos/eliza/graphs/contributors"> | ||
| <img src="https://contrib.rocks/image?repo=elizaos/eliza" /> | ||
| </a> | ||
|
|
||
| ## Star History | ||
|
|
||
| [](https://star-history.com/#elizaos/eliza&Date) | ||
| # Eliza 🤖 | ||
|
|
||
| <div align="center"> | ||
| <img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" /> | ||
| </div> | ||
|
|
||
| <div align="center"> | ||
|
|
||
| 📖 [Documentation](https://elizaos.github.io/eliza/) | 🎯 [Examples](https://github.com/thejoven/awesome-eliza) | ||
|
|
||
| </div> | ||
|
|
||
| ## 🌍 README Translations | ||
|
|
||
| [中文说明](./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) | ||
|
|
||
| ## 🚩 Overview | ||
|
|
||
| <div align="center"> | ||
| <img src="./docs/static/img/eliza_diagram.jpg" alt="Eliza Diagram" width="100%" /> | ||
| </div> | ||
|
|
||
| ## ✨ Features | ||
|
|
||
| - 🛠️ Full-featured Discord, Twitter and Telegram connectors | ||
| - 🔗 Support for every model (Llama, Grok, OpenAI, Anthropic, etc.) | ||
| - 👥 Multi-agent and room support | ||
| - 📚 Easily ingest and interact with your documents | ||
| - 💾 Retrievable memory and document store | ||
| - 🚀 Highly extensible - create your own actions and clients | ||
| - ☁️ Supports many models (local Llama, OpenAI, Anthropic, Groq, etc.) | ||
| - 📦 Just works! | ||
|
|
||
| ## Video Tutorials | ||
|
|
||
| [AI Agent Dev School](https://www.youtube.com/watch?v=ArptLpQiKfI&list=PLx5pnFXdPTRzWla0RaOxALTSTnVq53fKL) | ||
|
|
||
| ## 🎯 Use Cases | ||
|
|
||
| - 🤖 Chatbots | ||
| - 🕵️ Autonomous Agents | ||
| - 📈 Business Process Handling | ||
| - 🎮 Video Game NPCs | ||
| - 🧠 Trading | ||
|
|
||
| ## 🚀 Quick Start | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| - [Python 2.7+](https://www.python.org/downloads/) | ||
| - [Node.js 23+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) | ||
| - [pnpm](https://pnpm.io/installation) | ||
|
|
||
| > **Note for Windows Users:** [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install-manual) is required. | ||
| ### Use the Starter (Recommended) | ||
|
|
||
| ```bash | ||
| git clone https://github.com/elizaos/eliza-starter.git | ||
| cd eliza-starter | ||
| cp .env.example .env | ||
| pnpm i && pnpm build && pnpm start | ||
| ``` | ||
|
|
||
| Once the agent is running, you should see the message to run "pnpm start:client" at the end. | ||
| Open another terminal and move to same directory and then run below command and follow the URL to chat to your agent. | ||
|
|
||
| ```bash | ||
| pnpm start:client | ||
| ``` | ||
|
|
||
| Then read the [Documentation](https://elizaos.github.io/eliza/) to learn how to customize your Eliza. | ||
|
|
||
| ### Manually Start Eliza (Only recommended if you know what you are doing) | ||
|
|
||
| ```bash | ||
| # Clone the repository | ||
| git clone https://github.com/elizaos/eliza.git | ||
|
|
||
| # Checkout the latest release | ||
| # This project iterates fast, so we recommend checking out the latest release | ||
| git checkout $(git describe --tags --abbrev=0) | ||
| ``` | ||
|
|
||
| ### Start Eliza with Gitpod | ||
|
|
||
| [](https://gitpod.io/#https://github.com/elizaos/eliza/tree/main) | ||
|
|
||
| ### Edit the .env file | ||
|
|
||
| Copy .env.example to .env and fill in the appropriate values. | ||
|
|
||
| ``` | ||
| cp .env.example .env | ||
| ``` | ||
|
|
||
| Note: .env is optional. If you're planning to run multiple distinct agents, you can pass secrets through the character JSON | ||
| Note: .env is optional. If you're planning to run multiple distinct agents, you can pass secrets through the character JSON | ||
|
|
||
| ### Automatically Start Eliza | ||
|
|
||
| This will run everything to set up the project and start the bot with the default character. | ||
|
|
||
| ```bash | ||
| sh scripts/start.sh | ||
| ``` | ||
|
|
||
| ### Edit the character file | ||
|
|
||
| 1. Open `packages/core/src/defaultCharacter.ts` to modify the default character. Uncomment and edit. | ||
|
|
||
| 2. To load custom characters: | ||
| - Use `pnpm start --characters="path/to/your/character.json"` | ||
| - Multiple character files can be loaded simultaneously | ||
| 3. Connect with X (Twitter) | ||
| - change `"clients": []` to `"clients": ["twitter"]` in the character file to connect with X | ||
|
|
||
| ### Manually Start Eliza | ||
|
|
||
| ```bash | ||
| pnpm i | ||
| pnpm build | ||
| pnpm start | ||
|
|
||
| # The project iterates fast, sometimes you need to clean the project if you are coming back to the project | ||
| pnpm clean | ||
| ``` | ||
|
|
||
| #### Additional Requirements | ||
|
|
||
| You may need to install Sharp. If you see an error when starting up, try installing it with the following command: | ||
|
|
||
| ``` | ||
| pnpm install --include=optional sharp | ||
| ``` | ||
|
|
||
| ### Community & contact | ||
|
|
||
| - [GitHub Issues](https://github.com/elizaos/eliza/issues). Best for: bugs you encounter using Eliza, and feature proposals. | ||
| - [Discord](https://discord.gg/ai16z). Best for: sharing your applications and hanging out with the community. | ||
|
|
||
| ## Contributors | ||
|
|
||
| <a href="https://github.com/elizaos/eliza/graphs/contributors"> | ||
| <img src="https://contrib.rocks/image?repo=elizaos/eliza" /> | ||
| </a> | ||
|
|
||
| ## Star History | ||
|
|
||
| [](https://star-history.com/#elizaos/eliza&Date) |
Oops, something went wrong.