Merge branch 'develop' into fix/jsdoc-automation

Ed-Marcavage · web-flow · commit 8a1b6984bd81 · 2024-12-28T17:15:28.000-05:00
diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml
@@ -12,13 +12,23 @@ jobs:
       issues: write
       pull-requests: write
 
+    env:
+      DAYS_BEFORE_STALE: 30  # Define the days-before-stale value
+      DAYS_BEFORE_CLOSE: 7   # Define the days-before-close value
+
     steps:
     - uses: actions/stale@v5
       with:
         repo-token: ${{ secrets.GITHUB_TOKEN }}
-        stale-issue-message: 'This issue has been automatically marked as stale due to inactivity.'
-        stale-pr-message: 'This pull request has been automatically marked as stale due to inactivity.'
+        stale-issue-message: |
+          This issue has been automatically marked as stale due to ${{
+          env.DAYS_BEFORE_STALE }} days of inactivity.
+          If no further activity occurs within ${{ env.DAYS_BEFORE_CLOSE }} days, it will be closed automatically. Please take action if this issue is still relevant.
+        stale-pr-message: |
+          This pull request has been automatically marked as stale due to ${{
+          env.DAYS_BEFORE_STALE }} days of inactivity.
+          If no further activity occurs within ${{ env.DAYS_BEFORE_CLOSE }} days, it will be closed automatically. Please take action if this pull request is still relevant.
         stale-issue-label: 'no-issue-activity'
         stale-pr-label: 'no-pr-activity'
-        days-before-stale: 30  # Marks issues and PRs as stale after X days of inactivity
-        days-before-close: 7  # Closes issues and PRs X days after being marked as stale
+        days-before-stale: ${{ env.DAYS_BEFORE_STALE }}  
+        days-before-close: ${{ env.DAYS_BEFORE_CLOSE }}  
diff --git a/.gitignore b/.gitignore
@@ -49,6 +49,7 @@ packages/plugin-coinbase/src/plugins/transactions.csv
 tsup.config.bundled_*.mjs
 
 .turbo
+.cursorrules
 
 coverage
 .eslintcache
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@
 
 ## 🌍 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)
+[中文说明](./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)
 
 ## ✨ Features
 
@@ -56,7 +56,7 @@ 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. 
+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
 ```
@@ -86,11 +86,11 @@ Copy .env.example to .env and fill in the appropriate values.
 cp .env.example .env
 ```
 
-Note: .env is optional. If your 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 setup the project and start the bot with the default character.
+This will run everything to set up the project and start the bot with the default character.
 
 ```bash
 sh scripts/start.sh
diff --git a/README_CN.md b/README_CN.md
@@ -104,13 +104,55 @@ pnpm start
 
 ## 配置不同的大模型
 
-### 配置Llama
+您可以使用不同的大模型来驱动您的AI Agent，切换不同大模型需要两步：
 
-您可以通过设置 `XAI_MODEL` 环境变量为 `meta-llama/Meta-Llama-3.1-70B-Instruct-Turbo` 或 `meta-llama/Meta-Llama-3.1-405B-Instruct` 来运行 Llama 70B 或 405B 模型
+1. 确认您在`.env`文件内配置了对应的大模型API Key或对应的访问配置，例如如果您想使用OpenAI，则需要找到`OPENAI_API_KEY`参数，并填入您的OpenAI API Key，并以此类推。
+2. 在您的*Character*文件里找到`modelProvider`，并更改这里的内容，例如如果想要切换到Claude，则需要填入`anthropic`,以此来表明您将使用anthropic大模型作为您的对应Agent的Provider.
+
+在`.env`文件内您可以找到不同大模型的详细配置，包括设定具体想要使用对应提供商的哪个模型，下方我们给出了两个实例：
 
 ### 配置OpenAI
 
-您可以通过设置 `XAI_MODEL` 环境变量为 `gpt-4o-mini` 或 `gpt-4o` 来运行 OpenAI 模型
+首先您需要在Character文件内指定model provider
+
+```json
+    "name": "C-3PO",
+    "clients": [],
+    "modelProvider": "openai"
+    ...
+```
+
+其次请在`env`文件内配置相关参数
+
+```
+# AI Model API Keys
+OPENAI_API_KEY=                 # OpenAI API key, starting with sk-
+SMALL_OPENAI_MODEL=             # Default: gpt-4o-mini
+MEDIUM_OPENAI_MODEL=            # Default: gpt-4o
+LARGE_OPENAI_MODEL=             # Default: gpt-4o
+EMBEDDING_OPENAI_MODEL=         # Default: text-embedding-3-small
+IMAGE_OPENAI_MODEL=             # Default: dall-e-3
+
+```
+
+### 配置Anthorpic
+
+```json
+    "name": "C-3PO",
+    "clients": [],
+    "modelProvider": "anthropic"
+    ...
+```
+
+其次请在`env`文件内配置相关参数
+
+```
+# Anthropic Configuration
+ANTHROPIC_API_KEY=              # For Claude
+SMALL_ANTHROPIC_MODEL=          # Default: claude-3-haiku-20240307
+MEDIUM_ANTHROPIC_MODEL=         # Default: claude-3-5-sonnet-20241022
+LARGE_ANTHROPIC_MODEL=          # Default: claude-3-5-sonnet-20241022
+```
 
 ## 其他要求
 
diff --git a/README_PL.md b/README_PL.md
@@ -0,0 +1,137 @@
+# Eliza 🤖
+
+<div align="center">
+  <img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
+</div>
+
+<div align="center">
+
+📖 [Dokumentacja](https://elizaos.github.io/eliza/) | 🎯 [Przykłady](https://github.com/thejoven/awesome-eliza)
+
+</div>
+
+## ✨ Cechy modelu:
+
+- 🛠️ Pełne wsparcie dla Discorda, Telegrama i Twittera
+- 🔗 Wsparcie dla wszystkich modeli AI (Llama, Grok, OpenAI, Anthropic, itd.)
+- 👥 Wiele osobowości jednocześnie oraz wsparcie dla pokoi
+- 📚 Prosta konstrukcja i łatwość modyfikacji ustawień
+- 💾 Przywracalna pamięć i opcja przechowywania dokumentów
+- 🚀 Wiele możliwości rozszerzeń - twórz własne klienty, aplikacje itd
+- ☁️ Wsparcie dla szerokiej gamy modeli (local Llama, OpenAI, Anthropic, Groq, etc.)
+- 📦 To po prostu działa!
+
+## Poradniki wideo
+
+[AI Agent Dev School](https://www.youtube.com/watch?v=ArptLpQiKfI&list=PLx5pnFXdPTRzWla0RaOxALTSTnVq53fKL)
+
+## 🎯 Przykłady zastosowania
+
+- 🤖 Chatboty
+- 🕵️ Autonomiczni Agenci
+- 📈 Utrzymanie procesów biznesowych
+- 🎮 Zaplecze dla postaci NPC w grach
+- 🧠 Handel
+
+## 🚀 Jak zacząć?
+
+### Wstępne wymagania:
+
+- [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)
+
+> **Notka dla użytkowników Windowsa:** [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install-manual) jest wymagane!.
+
+### Użycie startera (Rekomendowane)
+
+```bash
+git clone https://github.com/elizaos/eliza-starter.git
+cd eliza-starter
+cp .env.example .env
+pnpm i && pnpm build && pnpm start
+```
+Gdy agent się uruchomi, powinien pojawić się komunikat aby uruchomić komendę "pnpm start:client".
+Wtedy trzeba odpalić drugi terminal, przejść do tego samego folderu, w którym mamy sklonowany kod z Githuba i odpalić tą komendę, aby być w stanie rozpocząć konwersację z naszym botem.
+```bash
+pnpm start:client
+```
+
+Następnie zapoznaj się z [Dokumentacją](https://elizaos.github.io/eliza/). Tam jest szcegółowo opisane, jak modyfikować i dopasować Elizę do własnych potrzeb.
+
+### Manualny start (Przeznaczone dla osób, które wiedzą, co robią)
+
+```bash
+# Sklonuj repozytorium
+git clone https://github.com/elizaos/eliza.git
+
+# Sprawdź, czy na pewno masz najnowszą wersję
+# Projekt rozrasta się bardzo szybko, dlatego zalecane jest aby często sprawdzać wersję
+git checkout $(git describe --tags --abbrev=0)
+```
+
+### Start przy użyciu Gitpod'a
+
+[![Otwórz w Gitpodzie](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/elizaos/eliza/tree/main)
+
+### Edytuj plik .env
+
+Zmień nazwę pliku .env.example na .env i wypełnij wartości zmiennych, które będą potrzebne do uruchomienia aplikacji.
+
+```
+cp .env.example .env
+```
+
+Uwaga: .env jest opcjonalne. Jeżeli planujesz stawiać więcej niż jedną postać, zalecane jest korzystanie z plików JSON dedykowanych dla charakterów. Będzie to bardziej przejrzyste i łatwiejsze do znalezienia gdy trzeba będzie wprowadzić jakieś zmiany.
+
+### Automatyczny start Elizy
+
+Ta komenda postawi projekt i uruchomi bota z domyślnym charakterem.
+
+```bash
+sh scripts/start.sh
+```
+
+### Edycja pliku postaci
+
+1. Otwórz `packages/core/src/defaultCharacter.ts` aby zmodyfikować postać. Odkomentuj i edytuj.
+
+2. Aby załadować niestandardowe osobowości:
+    - Uzyj komendy `pnpm start --characters="path/to/your/character.json"`
+    - Wiele plików z osobowościami może być załadowana jednocześnie
+3. Połącz z platformą X (niegdyś Twitter)
+    - zamień `"clients": []` na `"clients": ["twitter"]` w pliku osobowości aby połączyć z X
+
+### Manualny Start Elizy
+
+```bash
+pnpm i
+pnpm build
+pnpm start
+
+# Projekt rozwija się bardzo szybko, dlatego jeżeli robisz sobie przerwę na jakiś czas i wejdzie w międzyczasie dużo zmian, dobrze jest użyć tej komendy:
+pnpm clean
+```
+
+#### Dodatkowe wymagania
+
+Możesz musieć zainstalować pakiet Sharp. Jeżeli przy odpalaniu projektu wyskakuje błąd, spróbuj go zainstalować tą komendą:
+
+```
+pnpm install --include=optional sharp
+```
+
+### Społeczność i kontakt
+
+- [GitHub Issues](https://github.com/elizaos/eliza/issues). Korzystaj w przypadku gdy napotkasz na jakieś bugi podczas uzywania Elizy, lub masz jakieś propozycje rozwoju.
+- [Discord](https://discord.gg/ai16z). Używaj, gdy chcesz się pochwalić swoją aplikacją lub po prostu pogadać z kimś.
+
+## Osoby zaangażowane w rozwój:
+
+<a href="https://github.com/elizaos/eliza/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=elizaos/eliza" />
+</a>
+
+## Historia gwiazdek
+
+[![Wykres historii gwiazdek](https://api.star-history.com/svg?repos=elizaos/eliza&type=Date)](https://star-history.com/#elizaos/eliza&Date)
diff --git a/client/src/Chat.tsx b/client/src/Chat.tsx
@@ -1,11 +1,10 @@
-import { useRef, useState } from "react";
-import { useParams } from "react-router-dom";
-import { useMutation } from "@tanstack/react-query";
 import { Button } from "@/components/ui/button";
-import { ImageIcon } from "lucide-react";
 import { Input } from "@/components/ui/input";
+import { useMutation } from "@tanstack/react-query";
+import { ImageIcon } from "lucide-react";
+import { useEffect, useRef, useState } from "react";
+import { useParams } from "react-router-dom";
 import "./App.css";
-import path from "path";
 
 type TextResponse = {
     text: string;
@@ -19,6 +18,15 @@ export default function Chat() {
     const [messages, setMessages] = useState<TextResponse[]>([]);
     const [selectedFile, setSelectedFile] = useState<File | null>(null);
     const fileInputRef = useRef<HTMLInputElement>(null);
+    const messagesEndRef = useRef<HTMLDivElement>(null);
+
+    const scrollToBottom = () => {
+        messagesEndRef.current?.scrollIntoView({ behavior: "smooth" });
+    };
+
+    useEffect(() => {
+        scrollToBottom();
+    }, [messages]);
 
     const mutation = useMutation({
         mutationFn: async (text: string) => {
@@ -115,6 +123,7 @@ export default function Chat() {
                             No messages yet. Start a conversation!
                         </div>
                     )}
+                    <div ref={messagesEndRef} />
                 </div>
             </div>
 
diff --git a/packages/client-twitter/src/environment.ts b/packages/client-twitter/src/environment.ts
@@ -3,15 +3,15 @@ import { z } from "zod";
 export const DEFAULT_MAX_TWEET_LENGTH = 280;
 
 const twitterUsernameSchema = z.string()
-    .min(1)
-    .max(15)
-    .regex(/^[A-Za-z][A-Za-z0-9_]*[A-Za-z0-9]$|^[A-Za-z]$/, 'Invalid Twitter username format');
+    .min(4, 'An X/Twitter Username must be at least 4 characters long')
+    .max(15, 'n X/Twitter Username cannot exceed 15 characters')
+    .regex(/^[A-Za-z0-9_]*$/, 'n X Username can only contain letters, numbers, and underscores');
 
 export const twitterEnvSchema = z.object({
     TWITTER_DRY_RUN: z.boolean(),
-    TWITTER_USERNAME: z.string().min(1, "Twitter username is required"),
-    TWITTER_PASSWORD: z.string().min(1, "Twitter password is required"),
-    TWITTER_EMAIL: z.string().email("Valid Twitter email is required"),
+    TWITTER_USERNAME: z.string().min(1, "X/Twitter username is required"),
+    TWITTER_PASSWORD: z.string().min(1, "X/Twitter password is required"),
+    TWITTER_EMAIL: z.string().email("Valid X/Twitter email is required"),
     MAX_TWEET_LENGTH: z.number().int().default(DEFAULT_MAX_TWEET_LENGTH),
     TWITTER_SEARCH_ENABLE: z.boolean().default(false),
     TWITTER_2FA_SECRET: z.string(),
@@ -164,7 +164,7 @@ export async function validateTwitterConfig(
                 .map((err) => `${err.path.join(".")}: ${err.message}`)
                 .join("\n");
             throw new Error(
-                `Twitter configuration validation failed:\n${errorMessages}`
+                `X/Twitter configuration validation failed:\n${errorMessages}`
             );
         }
         throw error;
diff --git a/packages/client-twitter/src/post.ts b/packages/client-twitter/src/post.ts
@@ -44,20 +44,25 @@ export const twitterActionTemplate =
 {{postDirections}}
 
 Guidelines:
-- Highly selective engagement
-- Direct mentions are priority
-- Skip: low-effort content, off-topic, repetitive
+- ONLY engage with content that DIRECTLY relates to character's core interests
+- Direct mentions are priority IF they are on-topic
+- Skip ALL content that is:
+  - Off-topic or tangentially related
+  - From high-profile accounts unless explicitly relevant
+  - Generic/viral content without specific relevance
+  - Political/controversial unless central to character
+  - Promotional/marketing unless directly relevant
 
 Actions (respond only with tags):
-[LIKE] - Resonates with interests (9.5/10)
-[RETWEET] - Perfect character alignment (9/10)
-[QUOTE] - Can add unique value (8/10)
-[REPLY] - Memetic opportunity (9/10)
+[LIKE] - Perfect topic match AND aligns with character (9.8/10)
+[RETWEET] - Exceptional content that embodies character's expertise (9.5/10)
+[QUOTE] - Can add substantial domain expertise (9.5/10)
+[REPLY] - Can contribute meaningful, expert-level insight (9.5/10)
 
 Tweet:
 {{currentTweet}}
 
-# Respond with qualifying action tags only.` + postActionResponseFooter;
+# Respond with qualifying action tags only. Default to NO action unless extremely confident of relevance.` + postActionResponseFooter;
 
 /**
  * Truncate text to fit within the Twitter character limit, ensuring it ends at a complete sentence.
