Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Revamping README_PTBR.md for clearer and updated instructions (CONFLICTED) #2156

Merged
merged 1 commit into from
Mar 8, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 19 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

<div align="center">

📖 [Documentation](https://ai16z.github.io/eliza/) | 🎯 [Examples](https://github.com/thejoven/awesome-eliza)
📖 [Documentation](https://ai16z.github.io/eliza/) | 🎯 [Examples](https://github.com/thejoven/awesome-eliza)

</div>

Expand All @@ -16,33 +16,33 @@

## ✨ 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
- 📦 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.

Expand Down Expand Up @@ -122,8 +122,8 @@ 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/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.

## Contributors

Expand Down
208 changes: 74 additions & 134 deletions README_PTBR.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,183 +2,123 @@

<img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />

## Funcionalidades
## ✨ Features

- 🛠 Conectores completos para Discord, Twitter e Telegram
- 👥 Suporte a múltiplos agentes e salas
- 📚 Ingestão e interação fácil com seus documentos
- 💾 Memória recuperável e armazenamento de documentos
- 🚀 Altamente extensível - crie suas próprias ações e clientes para estender as capacidades
- ☁️ Suporta muitos modelos, incluindo Llama local, OpenAI, Anthropic, Groq e mais
- 📦 Funciona perfeitamente!
- 🛠️ Conexão completa para Discord, Twitter e Telegram
- 🔗 Suporte para todos os modelos (Llama, Grok, OpenAI, Anthropic, etc.)
- 👥 Suporte para multi-agente e salas
- 📚 Fácil interação com seus documentos
- 💾 Memória recuperável e armazenamento de documentos
- 🚀 Altamente extensível - crie suas próprias ações e clientes
- 📦 Simplesmente funciona!

## Para que posso usá-lo?
## Tutoriais

- 🤖 Chatbots
- 🕵️ Agentes autônomos
- 📈 Gestão de processos empresariais
- 🎮 NPCs em jogos de vídeo
[Escola Dev para Agentes IA (conteúdo em inglês)](https://www.youtube.com/watch?v=ArptLpQiKfI&list=PLx5pnFXdPTRzWla0RaOxALTSTnVq53fKL)

# Começando
## 🎯 Em que posso usar?

**Pré-requisitos (OBRIGATÓRIO):**
- 🤖 Chatbots
- 🕵️ Agentes autônomos
- 📈 Gestão de processos empresariais
- 🎮 NPCs para o seus jogos
- 🧠 Trading

- [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)
## 🚀 Começando

### Edite o arquivo .env

- Copie .env.example para .env e preencha os valores apropriados
- Edite as variáveis de ambiente do TWITTER para adicionar o nome de usuário e senha do seu bot
### Pré-requisitos

### Edite o arquivo de personagem
- [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)

- Confira o arquivo `src/core/defaultCharacter.ts` - você pode modificá-lo
- Você também pode carregar personagens com o comando `pnpm start --characters="path/to/your/character.json"` e executar múltiplos bots ao mesmo tempo.
> **Nota para usuários de Windows:** [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install-manual) é obrigatório.

Após configurar o arquivo .env e o arquivo de personagem, você pode iniciar o bot com o seguinte comando:
### Utilizando o Starter (Recomendado)

```
pnpm i
pnpm start
```

# Personalizando Eliza

### Adicionando ações personalizadas
```bash
git clone https://github.com/ai16z/eliza-starter.git

Para evitar conflitos no diretório core, recomendamos adicionar ações personalizadas a um diretório `custom_actions` e depois adicioná-las ao arquivo `elizaConfig.yaml`. Veja o arquivo `elizaConfig.example.yaml` para um exemplo.
cp .env.example .env

## Executando com diferentes modelos
pnpm i && pnpm build && pnpm start
```

### Executar com Llama
Leia a [Documentação](https://ai16z.github.io/eliza/) para aprender como customizar a sua Eliza.

Você pode executar modelos Llama 70B ou 405B configurando a variável de ambiente `XAI_MODEL` para `meta-llama/Meta-Llama-3.1-70B-Instruct-Turbo` ou `meta-llama/Meta-Llama-3.1-405B-Instruct`
### Executando Eliza manualmente (Recomendado apenas se você souber o que está fazendo)

### Executar com Grok
```bash
# Clone o repositório
git clone https://github.com/ai16z/eliza.git

Você pode executar modelos Grok configurando a variável de ambiente `XAI_MODEL` para `grok-beta`
# Dê checkout no último release
# O projeto está em constante e rápido desenvolvimento, então recomendamos que você cheque o último release
git checkout $(git describe --tags --abbrev=0)
```

### Executar com OpenAI
### Execute Eliza com Gitpod

Você pode executar modelos OpenAI configurando a variável de ambiente `XAI_MODEL` para `gpt-4o-mini` ou `gpt-4o`
[![Abrindo no Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/ai16z/eliza/tree/main)

## Requisitos Adicionais
### Edite o arquivo .env

Pode ser necessário instalar o Sharp. Se você encontrar um erro ao iniciar, tente instalá-lo com o seguinte comando:
Copie .env.example para .env e preencha os valores apropriados.

```
pnpm install --include=optional sharp
```

# Configuração do Ambiente

Você precisará adicionar variáveis de ambiente ao seu arquivo .env para se conectar a várias plataformas:

cp .env.example .env
```
# 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
TWITTER_COOKIES= # Cookies da conta

X_SERVER_URL=
XAI_API_KEY=
XAI_MODEL=

Nota: .env é opcional. Se você estiver planejando rodar múltiplos agentes distintos, você pode passar segredos pelo JSON do personagem

# Para perguntar coisas ao Claude
ANTHROPIC_API_KEY=
### Execute Eliza automaticamente

# EVM
EVM_PRIVATE_KEY=EXAMPLE_WALLET_PRIVATE_KEY
Isso vai executar tudo que é necessário para configurar o projeto e começar o bot com o personagem padrão.

# Solana
SOLANA_PRIVATE_KEY=EXAMPLE_WALLET_PRIVATE_KEY
SOLANA_PUBLIC_KEY=EXAMPLE_WALLET_PUBLIC_KEY
```bash
sh scripts/start.sh
```

# Fallback Wallet Configuration (deprecated)
WALLET_PRIVATE_KEY=EXAMPLE_WALLET_PRIVATE_KEY
WALLET_PUBLIC_KEY=EXAMPLE_WALLET_PUBLIC_KEY
### Edite o arquivo do personagem

BIRDEYE_API_KEY=
1. Abra `packages/core/src/defaultCharacter.ts` para modificar o personagem padrão. Descomente e edite.

SOL_ADDRESS=So11111111111111111111111111111111111111112
SLIPPAGE=1
RPC_URL=https://api.mainnet-beta.solana.com
HELIUS_API_KEY=
2. Para carregar personsagens customizáveis:
- Use `pnpm start --characters="path/to/your/character.json"`
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix typo in Portuguese translation: personsagens -> personagens

Spotted by Graphite Reviewer

Is this helpful? React 👍 or 👎 to let us know.

- Múltiplos arquivos de personagem podem ser usados de forma simultânea
3. Conectando com o X (Twitter)
- mude `"clients": []` para `"clients": ["twitter"]` no arquivo do personagem para conectar com o X

### Executando Eliza manualmente

## Telegram
TELEGRAM_BOT_TOKEN=
```bash
pnpm i
pnpm build
pnpm start

TOGETHER_API_KEY=
# O projeto está iterando bem rápido. Se você estiver voltando depois de um tempo, talvez precise fazer uma limpeza
pnpm clean
```

# Configuração de Inferência Local
#### Requerimentos adicionais

### Configuração CUDA

Se você tiver uma GPU NVIDIA, pode instalar o CUDA para acelerar dramaticamente a inferência local.
Talvez você precise instalar o Sharp. Se na hora de começar estiver apresentando algum erro, tente instalar com o seguinte comando:

```
pnpm install
npx --no node-llama-cpp source download --gpu cuda
pnpm install --include=optional sharp
```

Certifique-se de ter instalado o CUDA Toolkit, incluindo cuDNN e cuBLAS.

### Executando localmente

Adicione XAI_MODEL e configure-o para uma das opções acima de [Executar com Llama](#executar-com-llama) - você pode deixar X_SERVER_URL e XAI_API_KEY em branco, ele baixa o modelo do huggingface e faz consultas localmente

# Clientes
### Comunidade & contato

## Bot do Discord
- [GitHub Issues](https://github.com/ai16z/eliza/issues). Melhor utilizado para: bugs que você encontrar utilizando a Eliza, e propostas de features.
- [Discord](https://discord.gg/ai16z). Melhor para: compartilhar seus apps e se conectar com a comunidade.

Para ajuda com a configuração do seu Bot do Discord, confira aqui: https://discordjs.guide/preparations/setting-up-a-bot-application.html

# Desenvolvimento

## Testes

Para executar a suíte de testes:

```bash
pnpm test # Executar testes uma vez
pnpm test:watch # Executar testes no modo watch
```

Para testes específicos de banco de dados:

```bash
pnpm test:sqlite # Executar testes com SQLite
pnpm test:sqljs # Executar testes com SQL.js
```
## Contribuidores

Os testes são escritos usando Jest e podem ser encontrados em arquivos `src/**/*.test.ts`. O ambiente de teste está configurado para:
<a href="https://github.com/ai16z/eliza/graphs/contributors">
<img src="https://contrib.rocks/image?repo=ai16z/eliza" />
</a>

- Carregar variáveis de ambiente de `.env.test`
- Usar um tempo limite de 2 minutos para testes de longa duração
- Suportar módulos ESM
- Executar testes em sequência (--runInBand)
## Histórico de estrelas

Para criar novos testes, adicione um arquivo `.test.ts` adjacente ao código que você está testando.
[![Gráfico do histórico de estrelas](https://api.star-history.com/svg?repos=ai16z/eliza&type=Date)](https://star-history.com/#ai16z/eliza&Date)
Loading