Merge branch 'develop' into realitySpiral/closeStalPRsIssues

elizaOS · Dec 22, 2024 · 5feca18 · 5feca18
2 parents 5b4dc58 + e37fb6d
commit 5feca18
Show file tree

Hide file tree

Showing 727 changed files with 12,285 additions and 11,029 deletions.
diff --git a/.github/workflows/integrationTests.yaml b/.github/workflows/integrationTests.yaml
@@ -49,17 +49,13 @@ jobs:
               id: check_api_key
               run: |
                   if [ -z "$OPENAI_API_KEY" ]; then
-                    echo "::set-output name=api_key_present::false"
-                  else
-                    echo "::set-output name=api_key_present::true"
+                      echo "Error: OPENAI_API_KEY is not set."
+                      exit 1
                   fi
+              env:
+                  OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
 
             - name: Run integration tests
-              if: steps.check_api_key.outputs.api_key_present == 'true'
               run: pnpm run integrationTests
-
-            - name: Skip integration tests
-              if: steps.check_api_key.outputs.api_key_present == 'false'
-              run: |
-                  echo "Skipping integration tests due to missing required API keys"
-                  exit 1
+              env:
+                  OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -15,10 +15,10 @@ By contributing to Eliza, you agree that your contributions will be licensed und
 
 We believe in the power of the OODA Loop - a decision-making framework that emphasizes speed and adaptability. OODA stands for:
 
--   **Observe**: Gather information and insights about the project, the community, and the broader AI ecosystem.
--   **Orient**: Analyze your observations to identify opportunities for contribution and improvement.
--   **Decide**: Choose a course of action based on your analysis. This could be proposing a new feature, fixing a bug, or creating content.
--   **Act**: Execute your decision and share your work with the community.
+- **Observe**: Gather information and insights about the project, the community, and the broader AI ecosystem.
+- **Orient**: Analyze your observations to identify opportunities for contribution and improvement.
+- **Decide**: Choose a course of action based on your analysis. This could be proposing a new feature, fixing a bug, or creating content.
+- **Act**: Execute your decision and share your work with the community.
 
 ## How to Contribute
 
@@ -48,45 +48,45 @@ We believe in the power of the OODA Loop - a decision-making framework that emph
 
 ### Git Commit Messages
 
--   Use the present tense ("Add feature" not "Added feature")
--   Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
--   Limit the first line to 72 characters or less
--   Reference issues and pull requests liberally after the first line
+- Use the present tense ("Add feature" not "Added feature")
+- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
+- Limit the first line to 72 characters or less
+- Reference issues and pull requests liberally after the first line
 
 ### JavaScript Styleguide
 
--   All JavaScript must adhere to [JavaScript Standard Style](https://standardjs.com/).
+- All JavaScript must adhere to [JavaScript Standard Style](https://standardjs.com/).
 
 ### TypeScript Styleguide
 
--   All TypeScript must adhere to [TypeScript Standard Style](https://github.com/standard/ts-standard).
+- All TypeScript must adhere to [TypeScript Standard Style](https://github.com/standard/ts-standard).
 
 ### Documentation Styleguide
 
--   Use [Markdown](https://daringfireball.net/projects/markdown/) for documentation.
+- Use [Markdown](https://daringfireball.net/projects/markdown/) for documentation.
 
 ## Additional Notes
 
 ### Issue and Pull Request Labels
 
 This section lists the labels we use to help us track and manage issues and pull requests.
 
--   `bug` - Issues that are bugs.
--   `enhancement` - Issues that are feature requests.
--   `documentation` - Issues or pull requests related to documentation.
--   `good first issue` - Good for newcomers.
+- `bug` - Issues that are bugs.
+- `enhancement` - Issues that are feature requests.
+- `documentation` - Issues or pull requests related to documentation.
+- `good first issue` - Good for newcomers.
 
 ## Getting Help
 
--   Join [Discord](https://discord.gg/ai16z)
--   Check [FAQ](docs/community/faq.md)
--   Create GitHub issues
+- Join [Discord](https://discord.gg/ai16z)
+- Check [FAQ](docs/community/faq.md)
+- Create GitHub issues
 
 ## Additional Resources
 
--   [Local Development Guide](docs/guides/local-development.md)
--   [Configuration Guide](docs/guides/configuration.md)
--   [API Documentation](docs/api)
+- [Local Development Guide](docs/guides/local-development.md)
+- [Configuration Guide](docs/guides/configuration.md)
+- [API Documentation](docs/api)
 
 ## Contributor Guide
 
@@ -102,19 +102,19 @@ In the interest of fostering an open and welcoming environment, we as contributo
 
 Examples of behavior that contributes to creating a positive environment include:
 
--   Using welcoming and inclusive language
--   Being respectful of differing viewpoints and experiences
--   Gracefully accepting constructive criticism
--   Focusing on what is best for the community
--   Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior include:
 
--   The use of sexualized language or imagery and unwelcome sexual attention or advances
--   Trolling, insulting/derogatory comments, and personal or political attacks
--   Public or private harassment
--   Publishing others' private information without explicit permission
--   Other conduct which could reasonably be considered inappropriate in a professional setting
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
 
 #### Our Responsibilities
 

diff --git a/README.md b/README.md
@@ -6,62 +6,63 @@
 
 <div align="center">
 
-  📖 [Documentation](https://ai16z.github.io/eliza/) | 🎯 [Examples](https://github.com/thejoven/awesome-eliza)
+📖 [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/ai16z/Elisa/blob/main/README_HE.md)
+[中文说明](./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)
 
 ## ✨ 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!
+- 🛠️ 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
+- 🤖 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)
+- [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/ai16z/eliza-starter.git
+git clone https://github.com/elizaos/eliza-starter.git
 cd eliza-starter
 cp .env.example .env
 pnpm i && pnpm build && pnpm start
 ```
 
-Then read the [Documentation](https://ai16z.github.io/eliza/) to learn how to customize your Eliza.
+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/ai16z/eliza.git
+git clone https://github.com/elizaos/eliza.git
 
 # Checkout the latest release
 # This project iterates fast, so we recommend checking out the latest release
@@ -70,7 +71,7 @@ git checkout $(git describe --tags --abbrev=0)
 
 ### Start Eliza with Gitpod
 
-[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/ai16z/eliza/tree/main)
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/elizaos/eliza/tree/main)
 
 ### Edit the .env file
 
@@ -121,15 +122,15 @@ pnpm install --include=optional sharp
 
 ### Community & contact
 
--   [GitHub Issues](https://github.com/ai16z/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.
+- [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/ai16z/eliza/graphs/contributors">
-  <img src="https://contrib.rocks/image?repo=ai16z/eliza" />
+<a href="https://github.com/elizaos/eliza/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=elizaos/eliza" />
 </a>
 
 ## Star History
 
-[![Star History Chart](https://api.star-history.com/svg?repos=ai16z/eliza&type=Date)](https://star-history.com/#ai16z/eliza&Date)
+[![Star History Chart](https://api.star-history.com/svg?repos=elizaos/eliza&type=Date)](https://star-history.com/#elizaos/eliza&Date)
diff --git a/README_CN.md b/README_CN.md
@@ -4,43 +4,43 @@
 
 ## 功能
 
--   🛠 支持discord/推特/telegram连接
--   👥 支持多模态agent
--   📚 简单的导入文档并与文档交互
--   💾 可检索的内存和文档存储
--   🚀 高可拓展性，你可以自定义客户端和行为来进行功能拓展
--   ☁️ 多模型支持，包括Llama、OpenAI、Grok、Anthropic等
--   📦 简单好用
+- 🛠 支持discord/推特/telegram连接
+- 👥 支持多模态agent
+- 📚 简单的导入文档并与文档交互
+- 💾 可检索的内存和文档存储
+- 🚀 高可拓展性，你可以自定义客户端和行为来进行功能拓展
+- ☁️ 多模型支持，包括Llama、OpenAI、Grok、Anthropic等
+- 📦 简单好用
 
 你可以用Eliza做什么？
 
--   🤖 聊天机器人
--   🕵️ 自主Agents
--   📈 业务流程自动化处理
--   🎮 游戏NPC
+- 🤖 聊天机器人
+- 🕵️ 自主Agents
+- 📈 业务流程自动化处理
+- 🎮 游戏NPC
 
 # 开始使用
 
 **前置要求(必须):**
 
--   [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)
+- [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)
 
 以下是两种基础的Eliza下载方案, 请根据情况自行选择。
 
 ## (A) 使用启动器(Starter): 推荐
 
 ```
-git clone https://github.com/ai16z/eliza-starter.git
+git clone https://github.com/elizaos/eliza-starter.git
 cd eliza-starter
 cp .env.example .env
 ```
 
 ## (B) 手动启动Eliza: 仅在您知道自己在做什么时才推荐
 
 ```
-git clone https://github.com/ai16z/eliza.git
+git clone https://github.com/elizaos/eliza.git
 cd eliza
 # 切换最新发布的版本(Checkout the latest release)
 # Eliza的迭代速度非常快, 所以我们建议经常性的切换到最新的发布版本以免出现问题(This project iterates fast, so we recommend checking out the latest release)
@@ -51,10 +51,11 @@ git checkout $(git describe --tags --abbrev=0)
 
 ### 1. 编辑.env文件(环境变量)
 
--   将 `.env.example` 复制为 `.env` 并在其中填写适当的值
--   编辑推特环境并输入你的推特账号和密码
+- 将 `.env.example` 复制为 `.env` 并在其中填写适当的值
+- 编辑推特环境并输入你的推特账号和密码
+
+**最简化配置方案**:
 
-**最简化配置方案**: 
 ```
 OPENAI_API_KEY=sk-xxx # 配置OpenAI 的API, sk-开头, 注意, 目前不支持AzureOpenAI!
 
@@ -70,15 +71,15 @@ TWITTER_2FA_SECRET=          # Two-factor authentication
 
 ### 2. 编辑角色文件
 
--   标准的角色个性定义在文件 `characters/*.character.json`中, 您可以修改它或者直接使用它。
--   您也可以使用 `node --loader ts-node/esm src/index.ts --characters="path/to/your/character.json"` 加载角色并同时运行多个机器人。
--   需要说明的是, 在`characters/*.character.json`中, `clients字段对应**服务**, 默认可选`"twitter", "discord", "telegram"`等, 如果在`clients`中填入了如"twitter"等内容, 则需要在
-    上面的`env`配置对应的环境变量。对`discord`和`telegram`同理。
+- 标准的角色个性定义在文件 `characters/*.character.json`中, 您可以修改它或者直接使用它。
+- 您也可以使用 `node --loader ts-node/esm src/index.ts --characters="path/to/your/character.json"` 加载角色并同时运行多个机器人。
+- 需要说明的是, 在`characters/*.character.json`中, `clients字段对应**服务**, 默认可选`"twitter", "discord", "telegram"`等, 如果在`clients`中填入了如"twitter"等内容, 则需要在
+上面的`env`配置对应的环境变量。对`discord`和`telegram`同理。
 
 ```
 {
     "name": "trump",
-    "clients": ["twitter"], 
+    "clients": ["twitter"],
     "modelProvider": "openai",
 ```
 
@@ -95,7 +96,6 @@ pnpm build
 pnpm start
 ```
 
-
 # 自定义Eliza
 
 ### 添加常规行为
@@ -221,9 +221,9 @@ pnpm test:sqljs    # Run tests with SQL.js
 
 测试使用 Jest 编写，位于 src/\*_/_.test.ts 文件中。测试环境配置如下：
 
--   从 .env.test 加载环境变量
--   使用 2 分钟的超时时间来运行长时间运行的测试
--   支持 ESM 模块
--   按顺序运行测试 (--runInBand)
+- 从 .env.test 加载环境变量
+- 使用 2 分钟的超时时间来运行长时间运行的测试
+- 支持 ESM 模块
+- 按顺序运行测试 (--runInBand)
 
 要创建新测试，请在要测试的代码旁边添加一个 .test.ts 文件。