Merge pull request #1290 from ai16z/develop

feat: Update main for v0.1.6-alpha.5

.env.example

@@ -1,3 +1,7 @@
+# Cache Configs
+CACHE_STORE=database # Defaults to database. Other available cache store: redis and filesystem
+REDIS_URL= # Redis URL - could be a local redis instance or cloud hosted redis. Also support rediss:// urls
+
 # Discord Configuration
 DISCORD_APPLICATION_ID=
 DISCORD_API_TOKEN=              # Bot token
@@ -34,6 +38,9 @@ LARGE_HYPERBOLIC_MODEL=         # Default: meta-llama/Meta-Llama-3.1-405-Instruc
 # Speech Synthesis
 ELEVENLABS_XI_API_KEY=          # API key from elevenlabs
 
+# Direct Client Setting
+EXPRESS_MAX_PAYLOAD= # Default: 100kb
+
 # ElevenLabs Settings
 ELEVENLABS_MODEL_ID=eleven_multilingual_v2
 ELEVENLABS_VOICE_ID=21m00Tcm4TlvDq8ikWAM
@@ -55,6 +62,7 @@ TWITTER_COOKIES=                # Account cookies
 TWITTER_POLL_INTERVAL=120       # How often (in seconds) the bot should check for interactions
 TWITTER_SEARCH_ENABLE=FALSE     # Enable timeline search, WARNING this greatly increases your chance of getting banned
 TWITTER_TARGET_USERS=           # Comma separated list of Twitter user names to interact with
+TWITTER_RETRY_LIMIT=            # Maximum retry attempts for Twitter login
 
 X_SERVER_URL=
 XAI_API_KEY=
@@ -257,6 +265,9 @@ LARGE_AKASH_CHAT_API_MODEL=  # Default: Meta-Llama-3-1-405B-Instruct-FP8
 FAL_API_KEY=
 FAL_AI_LORA_PATH=
 
+# Web search API Configuration
+TAVILY_API_KEY=
+
 # WhatsApp Cloud API Configuration
 WHATSAPP_ACCESS_TOKEN=          # Permanent access token from Facebook Developer Console
 WHATSAPP_PHONE_NUMBER_ID=       # Phone number ID from WhatsApp Business API

.github/workflows/image.yaml

@@ -9,53 +9,62 @@ on:
 
 # Defines two custom environment variables for the workflow. These are used for the Container registry domain, and a name for the Docker image that this workflow builds.
 env:
-  REGISTRY: ghcr.io
-  IMAGE_NAME: ${{ github.repository }}
+    REGISTRY: ghcr.io
+    IMAGE_NAME: ${{ github.repository }}
 
 # There is a single job in this workflow. It's configured to run on the latest available version of Ubuntu.
 jobs:
-  build-and-push-image:
-    runs-on: ubuntu-latest
-    # Sets the permissions granted to the `GITHUB_TOKEN` for the actions in this job.
-    permissions:
-      contents: read
-      packages: write
-      attestations: write
-      id-token: write
-      # 
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-      # Uses the `docker/login-action` action to log in to the Container registry registry using the account and password that will publish the packages. Once published, the packages are scoped to the account defined here.
-      - name: Log in to the Container registry
-        uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1
-        with:
-          registry: ${{ env.REGISTRY }}
-          username: ${{ github.actor }}
-          password: ${{ secrets.GITHUB_TOKEN }}
-      # This step uses [docker/metadata-action](https://github.com/docker/metadata-action#about) to extract tags and labels that will be applied to the specified image. The `id` "meta" allows the output of this step to be referenced in a subsequent step. The `images` value provides the base name for the tags and labels.
-      - name: Extract metadata (tags, labels) for Docker
-        id: meta
-        uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
-        with:
-          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
-      # This step uses the `docker/build-push-action` action to build the image, based on your repository's `Dockerfile`. If the build succeeds, it pushes the image to GitHub Packages.
-      # It uses the `context` parameter to define the build's context as the set of files located in the specified path. For more information, see "[Usage](https://github.com/docker/build-push-action#usage)" in the README of the `docker/build-push-action` repository.
-      # It uses the `tags` and `labels` parameters to tag and label the image with the output from the "meta" step.
-      - name: Build and push Docker image
-        id: push
-        uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4
-        with:
-          context: .
-          push: true
-          tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}
-
-      # This step generates an artifact attestation for the image, which is an unforgeable statement about where and how it was built. It increases supply chain security for people who consume the image. For more information, see "[AUTOTITLE](/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds)." 
-      - name: Generate artifact attestation
-        uses: actions/attest-build-provenance@v1
-        with:
-          subject-name: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME}}
-          subject-digest: ${{ steps.push.outputs.digest }}
-          push-to-registry: true
-
+    build-and-push-image:
+        runs-on: ubuntu-latest
+        # Sets the permissions granted to the `GITHUB_TOKEN` for the actions in this job.
+        permissions:
+            contents: read
+            packages: write
+            attestations: write
+            id-token: write
+            #
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v4
+            # Uses the `docker/login-action` action to log in to the Container registry registry using the account and password that will publish the packages. Once published, the packages are scoped to the account defined here.
+            - name: Log in to the Container registry
+              uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1
+              with:
+                  registry: ${{ env.REGISTRY }}
+                  username: ${{ github.actor }}
+                  password: ${{ secrets.GITHUB_TOKEN }}
+            # This step uses [docker/metadata-action](https://github.com/docker/metadata-action#about) to extract tags and labels that will be applied to the specified image. The `id` "meta" allows the output of this step to be referenced in a subsequent step. The `images` value provides the base name for the tags and labels.
+            - name: Extract metadata (tags, labels) for Docker
+              id: meta
+              uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
+              with:
+                  images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+            # This step uses the `docker/build-push-action` action to build the image, based on your repository's `Dockerfile`. If the build succeeds, it pushes the image to GitHub Packages.
+            # It uses the `context` parameter to define the build's context as the set of files located in the specified path. For more information, see "[Usage](https://github.com/docker/build-push-action#usage)" in the README of the `docker/build-push-action` repository.
+            # It uses the `tags` and `labels` parameters to tag and label the image with the output from the "meta" step.
+            - name: Build and push Docker image
+              id: push
+              uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4
+              with:
+                  context: .
+                  push: true
+                  tags: ${{ steps.meta.outputs.tags }}
+                  labels: ${{ steps.meta.outputs.labels }}
+
+            # This step generates an artifact attestation for the image, which is an unforgeable statement about where and how it was built. It increases supply chain security for people who consume the image. For more information, see "[AUTOTITLE](/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds)."
+            - name: Generate artifact attestation
+              uses: actions/attest-build-provenance@v1
+              with:
+                  subject-name: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME}}
+                  subject-digest: ${{ steps.push.outputs.digest }}
+                  push-to-registry: true
+
+            # This step makes the Docker image public, so users can pull it without authentication.
+            - name: Make Docker image public
+              run: |
+                  curl \
+                    -X PATCH \
+                    -H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
+                    -H "Accept: application/vnd.github.v3+json" \
+                    https://api.github.com/user/packages/container/${{ env.IMAGE_NAME }}/visibility \
+                    -d '{"visibility":"public"}'

.github/workflows/integrationTests.yaml

@@ -3,7 +3,7 @@ on:
     push:
         branches:
             - "*"
-    pull_request_target:
+    pull_request:
         branches:
             - "*"
 jobs:
@@ -25,6 +25,8 @@ jobs:
               run: pnpm run smokeTests
     integration-tests:
         runs-on: ubuntu-latest
+        env:
+            OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
         steps:
             - uses: actions/checkout@v4
 
@@ -43,13 +45,21 @@ jobs:
             - name: Build packages
               run: pnpm build
 
-            - name: Run integration tests
-              env:
-                  OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+            - name: Check for API key
+              id: check_api_key
               run: |
                   if [ -z "$OPENAI_API_KEY" ]; then
-                    echo "Skipping integration tests due to missing required API keys"
-                    exit 1
+                    echo "::set-output name=api_key_present::false"
                   else
-                    pnpm run integrationTests
+                    echo "::set-output name=api_key_present::true"
                   fi
+
+            - 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

.gitignore

@@ -52,3 +52,5 @@ tsup.config.bundled_*.mjs
 
 coverage
 .eslintcache
+
+agent/content

.gitpod.yml

@@ -3,5 +3,6 @@ tasks:
   - name: "init eliza env"
     init: |
       nvm install v23.3.0
+      git fetch --tags
       git checkout $(git describe --tags --abbrev=0)
     command: pnpm install && pnpm run build

Dockerfile

@@ -52,4 +52,4 @@ COPY --from=builder /app/scripts ./scripts
 COPY --from=builder /app/characters ./characters
 
 # Set the command to run the application
-CMD ["pnpm", "start", "--non-interactive"]
+CMD ["pnpm", "start"]

README.md

@@ -50,9 +50,8 @@
 
 ```bash
 git clone https://github.com/ai16z/eliza-starter.git
-
+cd eliza-starter
 cp .env.example .env
-
 pnpm i && pnpm build && pnpm start
 ```
 

README_CN.md

@@ -21,30 +21,81 @@
 
 # 开始使用
 
-**前置要求（必须）:**
+**前置要求(必须):**
 
+-   [Python 2.7+](https://www.python.org/downloads/)
 -   [Node.js 23+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
--   Nodejs安装
 -   [pnpm](https://pnpm.io/installation)
--   使用pnpm
 
-### 编辑.env文件
+以下是两种基础的Eliza下载方案, 请根据情况自行选择。
 
--   -   将 .env.example 复制为 .env 并填写适当的值
+## (A) 使用启动器(Starter): 推荐
+
+```
+git clone https://github.com/ai16z/eliza-starter.git
+cd eliza-starter
+cp .env.example .env
+```
+
+## (B) 手动启动Eliza: 仅在您知道自己在做什么时才推荐
+
+```
+git clone https://github.com/ai16z/eliza.git
+cd eliza
+# 切换最新发布的版本(Checkout the latest release)
+# Eliza的迭代速度非常快, 所以我们建议经常性的切换到最新的发布版本以免出现问题(This project iterates fast, so we recommend checking out the latest release)
+git checkout $(git describe --tags --abbrev=0)
+```
+
+在将代码下载到本地后, 我们要做两件事:
+
+### 1. 编辑.env文件(环境变量)
+
+-   将 `.env.example` 复制为 `.env` 并在其中填写适当的值
 -   编辑推特环境并输入你的推特账号和密码
 
-### 编辑角色文件
+**最简化配置方案**: 
+```
+OPENAI_API_KEY=sk-xxx # 配置OpenAI 的API, sk-开头, 注意, 目前不支持AzureOpenAI!
 
--   查看文件 `src/core/defaultCharacter.ts` - 您可以修改它
+## 如配置Twitter/X, 则需配置
+# Twitter/X Configuration
+TWITTER_DRY_RUN=false
+TWITTER_USERNAME=abc         # Your Twitter/X account username
+TWITTER_PASSWORD=abc         # Your Twitter/X account password
+TWITTER_EMAIL= xxx@gmail.com # Your Twitter/X account email
+TWITTER_COOKIES= ''          # Your Twitter/X cookies, copy from broswer
+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`同理。
+
+```
+{
+    "name": "trump",
+    "clients": ["twitter"], 
+    "modelProvider": "openai",
+```
 
-在完成账号和角色文件的配置后，输入以下命令行启动你的bot：
+在完成环境变量和角色文件的配置后，输入以下命令行启动你的bot：
 
 ```
+(A) 使用启动器(Starter)
+sh scripts/start.sh
+
+
+(B) 手动启动Eliza
 pnpm i
+pnpm build
 pnpm start
 ```
 
+
 # 自定义Eliza
 
 ### 添加常规行为

README_ES.md

@@ -9,7 +9,7 @@
 -   📚 Ingestión e interacción sencilla con documentos
 -   💾 Memoria recuperable y almacenamiento de documentos
 -   🚀 Altamente extensible - cree sus propias acciones y clientes para expandir capacidades
--   ☁️ Soporta múltiples modelos, incluyendo Llama local, OpenAI, Anthropic, Groq y más
+-   ☁️ Soporta múltiples modelos, incluidos Llama local, OpenAI, Anthropic, Groq y más
 -   📦 Funciona perfectamente
 
 ## Usos
@@ -29,8 +29,8 @@
 
 ### Edite el archivo .env
 
--   Copie .env.example a .env y complete los valores apropiados
--   Edite las variables de ambiente de TWITTER para agregar nombre de usuario y contraseña del bot
+-   Copie el archivo .env.example a .env y complete los valores apropiados
+-   Edite las variables de entorno de TWITTER para agregar nombre de usuario y contraseña del bot
 
 ### Edite el archivo de personaje
 

README_FR.md

@@ -7,17 +7,17 @@
 -   🛠 Support des connecteurs Discord/ Twitter / Telegram
 -   🔗 Support des différents modèles d'IA (Llama, Grok, OpenAI, Anthropic, etc.)
 -   👥 Gestion de plusieurs agents et assistance
--   📚 Import et intéractions avec différents types de documents simplifiés
+-   📚 Import et interactions avec différents types de documents simplifiés
 -   💾 Accès aux données en mémoire et aux documents stockés
 -   🚀 Grande personnalisation possible : création de nouveaux clients et de nouvelles actions
 -   📦 Simplicité d'utilisation
 
 Que pouvez-vous faire avec Eliza?
 
 -   🤖 Chatbot
--   🕵 ️Agents autonomes
+-   🕵 Agents autonomes
 -   📈 Processus automatisés
--   🎮 PNJ intéractifs
+-   🎮 PNJ interactifs
 -   🧠 Trading automatisé
 
 # Premiers pas
@@ -32,7 +32,7 @@ Que pouvez-vous faire avec Eliza?
 
 ### Editer le fichier .env
 
--   Copier le fichier d'example et le remplir le avec les valeurs adéquates
+-   Copier le fichier d'exemple .env.example et le remplir avec les valeurs adéquates
 
 ```
 cp .env.example .env
@@ -59,10 +59,10 @@ pnpm start
 pnpm clean
 ```
 
-#### Ressources additionelles
+#### Ressources additionnelles
 
 Il vous faudra peut-être installer Sharp.
-Si il y a une erreur lors du lancement du bot, essayez d'installer Sharp comme ceci :
+S'il y a une erreur lors du lancement du bot, essayez d'installer Sharp comme ceci :
 
 ```
 pnpm install --include=optional sharp