From efe5ac38ffeeb812eac2e52bdf3b0d9a887926fa Mon Sep 17 00:00:00 2001 From: Pedro Borges Date: Fri, 3 Jan 2025 14:29:10 -0300 Subject: [PATCH 1/2] docs: add Romanian README translation --- README.md | 282 +++++++++++++++++++++++++-------------------------- README_RO.md | 183 +++++++++++++++++++++++++++++++++ 2 files changed, 324 insertions(+), 141 deletions(-) create mode 100644 README_RO.md diff --git a/README.md b/README.md index 4c91531ddb..962653ff46 100644 --- a/README.md +++ b/README.md @@ -1,141 +1,141 @@ -# Eliza 🤖 - -
- Eliza Banner -
- -
- -📖 [Documentation](https://elizaos.github.io/eliza/) | 🎯 [Examples](https://github.com/thejoven/awesome-eliza) - -
- -## 🌍 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) - -## ✨ 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 - -[![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 - -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 - -### Automatically Start Eliza - -This will run everything to setup 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 - - - - - -## Star History - -[![Star History Chart](https://api.star-history.com/svg?repos=elizaos/eliza&type=Date)](https://star-history.com/#elizaos/eliza&Date) +# Eliza 🤖 + +
+ Eliza Banner +
+ +
+ +📖 [Documentation](https://elizaos.github.io/eliza/) | 🎯 [Examples](https://github.com/thejoven/awesome-eliza) + +
+ +## 🌍 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) | [Română](./README_RO.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! + +## 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 + +[![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 + +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 + +### Automatically Start Eliza + +This will run everything to setup 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 + + + + + +## Star History + +[![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_RO.md b/README_RO.md new file mode 100644 index 0000000000..41780ef2dd --- /dev/null +++ b/README_RO.md @@ -0,0 +1,183 @@ +# Eliza + +Eliza Banner + +## Funcționalități + +- 🛠 Conectori compleți pentru Discord, Twitter și Telegram +- 👥 Suport pentru agenți multipli și camere +- 📚 Ingestie și interacțiune ușoară cu documentele tale +- 💾 Memorie recuperabilă și stocare de documente +- 🚀 Extensibil în mod ridicat – creează propriile acțiuni și clienți pentru a extinde capacitățile +- ☁️ Suportă multe modele, inclusiv Llama local, OpenAI, Anthropic, Groq și altele +- 📦 Funcționează perfect! + +## Pentru ce pot să-l folosesc? + +- 🤖 Chatbot-uri +- 🕵️ Agenți autonomi +- 📈 Gestiunea proceselor de afaceri +- 🎮 NPC-uri în jocuri video + +# Început + +**Cerințe preliminare (OBLIGATORIU):** + +- [Python 2.7+](https://www.python.org/downloads/) +- [Node.js 23.3+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) +- [pnpm](https://pnpm.io/installation) + +### Edite fișierul .env + +- Copiați `.env.example` în `.env` și completați valorile corespunzătoare +- Editați variabilele de mediu pentru TWITTER pentru a adăuga numele de utilizator și parola botului dvs. + +### Edite fișierul de personaj + +- Verificați fișierul `src/core/defaultCharacter.ts` – îl puteți modifica +- De asemenea, puteți încărca personaje cu comanda `pnpm start --characters="path/to/your/character.json"` și rula mai mulți boți în același timp. + +După ce ați configurat fișierul .env și fișierul de personaj, puteți porni botul cu următoarea comandă: + +``` +pnpm i +pnpm start +``` + +# Personalizarea Eliza + +### Adăugarea de acțiuni personalizate + +Pentru a evita conflicte în directorul core, vă recomandăm să adăugați acțiuni personalizate într-un director `custom_actions` și apoi să le includeți în fișierul `elizaConfig.yaml`. Consultați fișierul `elizaConfig.example.yaml` pentru un exemplu. + +## Rularea cu modele diferite + +### Rularea cu Llama + +Puteți rula modele Llama 70B sau 405B setând variabila de mediu `XAI_MODEL` la `meta-llama/Meta-Llama-3.1-70B-Instruct-Turbo` sau `meta-llama/Meta-Llama-3.1-405B-Instruct`. + +### Rularea cu Grok + +Puteți rula modele Grok setând variabila de mediu `XAI_MODEL` la `grok-beta`. + +### Rularea cu OpenAI + +Puteți rula modele OpenAI setând variabila de mediu `XAI_MODEL` la `gpt-4o-mini` sau `gpt-4o`. + +## Cerințe suplimentare + +Este posibil să fie necesară instalarea Sharp. Dacă întâmpinați o eroare la pornire, încercați să îl instalați cu următoarea comandă: + +``` +pnpm install --include=optional sharp +``` + +# Configurarea mediului + +Va trebui să adăugați variabile de mediu în fișierul dvs. `.env` pentru a vă conecta la diverse platforme: + +``` +# Variáveis de ambiente obrigatórias +DISCORD_APPLICATION_ID= +DISCORD_API_TOKEN= # Token do bot +OPENAI_API_KEY=sk-* # Chave API do OpenAI, começando com sk- +ELEVENLABS_XI_API_KEY= # Chave API do elevenlabs +GOOGLE_GENERATIVE_AI_API_KEY= # Chave API do Gemini + +# CONFIGURAÇÕES DO ELEVENLABS +ELEVENLABS_MODEL_ID=eleven_multilingual_v2 +ELEVENLABS_VOICE_ID=21m00Tcm4TlvDq8ikWAM +ELEVENLABS_VOICE_STABILITY=0.5 +ELEVENLABS_VOICE_SIMILARITY_BOOST=0.9 +ELEVENLABS_VOICE_STYLE=0.66 +ELEVENLABS_VOICE_USE_SPEAKER_BOOST=false +ELEVENLABS_OPTIMIZE_STREAMING_LATENCY=4 +ELEVENLABS_OUTPUT_FORMAT=pcm_16000 + +TWITTER_DRY_RUN=false +TWITTER_USERNAME= # Nome de usuário da conta +TWITTER_PASSWORD= # Senha da conta +TWITTER_EMAIL= # Email da conta + +X_SERVER_URL= +XAI_API_KEY= +XAI_MODEL= + + +# Para perguntar coisas ao Claude +ANTHROPIC_API_KEY= + +# EVM +EVM_PRIVATE_KEY=EXAMPLE_WALLET_PRIVATE_KEY + +# Solana +SOLANA_PRIVATE_KEY=EXAMPLE_WALLET_PRIVATE_KEY +SOLANA_PUBLIC_KEY=EXAMPLE_WALLET_PUBLIC_KEY + +# Fallback Wallet Configuration (deprecated) +WALLET_PRIVATE_KEY=EXAMPLE_WALLET_PRIVATE_KEY +WALLET_PUBLIC_KEY=EXAMPLE_WALLET_PUBLIC_KEY + +BIRDEYE_API_KEY= + +SOL_ADDRESS=So11111111111111111111111111111111111111112 +SLIPPAGE=1 +RPC_URL=https://api.mainnet-beta.solana.com +HELIUS_API_KEY= + + +## Telegram +TELEGRAM_BOT_TOKEN= + +TOGETHER_API_KEY= +``` + +# Configurarea inferenței locale + +### Configurarea CUDA + +Dacă aveți un GPU NVIDIA, puteți instala CUDA pentru a accelera dramatic inferența locală. + +``` +pnpm install +npx --no node-llama-cpp source download --gpu cuda +``` + +Asigurați-vă că ați instalat CUDA Toolkit, inclusiv cuDNN și cuBLAS. + +### Rularea locală + +Adăugați `XAI_MODEL` și setați-l la una dintre opțiunile de mai sus din [Rularea cu Llama](#rularea-cu-llama) – puteți lăsa `X_SERVER_URL` și `XAI_API_KEY` necompletate, modelul va fi descărcat de pe Hugging Face și interogările vor fi făcute local. + +# Clienți + +## Bot Discord + +Pentru ajutor la configurarea Bot-ului Discord, consultați: https://discordjs.guide/preparations/setting-up-a-bot-application.html + +# Dezvoltare + +## Teste + +Pentru a rula suita de teste: + +```bash +pnpm test # Execută testele o dată +pnpm test:watch # Execută testele în modul watch +``` + +Pentru teste specifice bazei de date: + +```bash +pnpm test:sqlite # Execută testele cu SQLite +pnpm test:sqljs # Execută testele cu SQL.js +``` + +Testele sunt scrise folosind Jest și pot fi găsite în fișierele `src/**/*.test.ts`. Mediul de testare este configurat pentru: + +- Încărcarea variabilelor de mediu din `.env.test` +- Utilizarea unui timeout de 2 minute pentru teste de lungă durată +- Suport pentru module ESM +- Rularea testelor în secvență (`--runInBand`) + +Pentru a crea teste noi, adăugați un fișier `.test.ts` adiacent codului pe care îl testați. From 5c0fd8dce062aaa7270c361f603e862b56eb7636 Mon Sep 17 00:00:00 2001 From: Odilitime Date: Sun, 5 Jan 2025 07:33:19 -0800 Subject: [PATCH 2/2] fix bad merge --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2c048e27b9..5ee788e692 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,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. +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