Home

Zyra Wiki

Bem-vindo à Wiki do Zyra.

O Zyra é um bot para WhatsApp focado em automação, moderação, observabilidade e persistência de dados. Ele usa Baileys como base de conexão e oferece uma arquitetura pronta para crescer com comandos, eventos e integrações.

O que é o projeto

O Zyra é uma aplicação Node.js/TypeScript que:

• conecta sessões WhatsApp com suporte a multi-dispositivo
• processa eventos em tempo real (mensagens, grupos, reações, mídia e sistema)
• persiste dados em MySQL e Redis (com fallback local)
• disponibiliza estrutura de comandos para funcionalidades de bot
• inclui mecanismos de estabilidade operacional (logs, reconexão, backfill, PM2)

Para que pode ser usado

Você pode usar o Zyra para:

• Atendimento e automação: respostas automáticas, comandos utilitários e fluxos internos
• Moderação de grupos: anti-link, controle de participantes e ações administrativas
• Observabilidade e auditoria: trilha de eventos, histórico de mensagens e diagnóstico
• Inteligência operacional: base de dados para métricas, relatórios e análise de uso
• Plataforma de extensão: criação de novos comandos e integrações customizadas

Principais recursos

• Comandos modulares (fácil de manter e expandir)
• Persistência SQL robusta (mensagens, mídia, eventos, usuários, grupos)
• Cache e aceleração com Redis
• Backfill para completar e normalizar dados históricos
• Download e gestão de mídia local com metadados
• Execução em produção com PM2

Arquitetura (visão rápida)

• src/events -> assinatura e tratamento dos eventos do WhatsApp
• src/router e src/commands -> roteamento e execução de comandos
• src/store -> persistência (SQL/Redis/cache)
• src/core -> runtime, conexão, banco e infraestrutura
• docs -> modelo de banco e documentação auxiliar

Requisitos

• Node.js (LTS)
• MySQL 8+
• Redis (opcional, recomendado)
• PM2 (opcional, recomendado para produção)

Começando

1. Configurar variáveis de ambiente no .env
2. Inicializar schema: npm run db:init
3. Rodar em dev: npm run dev
4. Produção com PM2: npm run pm2:start

Próximas páginas da Wiki

• Instalação detalhada
• Configuração de ambiente
• Guia de comandos
• Modelagem de banco
• Operação em produção
• Troubleshooting