---

Aviso: Este projeto está em evolução ativa. Possui capacidades centrais sólidas e cobertura de testes, e continuamos a melhorar a documentação, o fortalecimento e a profundidade dos recursos a cada versão. Contribuições, relatórios de bugs e feedbacks são muito bem-vindos.

Recursos

• Investigação visual em grafo — arraste e solte entidades, explore conexões interativamente
• Mais de 20 transformações integradas — DNS, WHOIS, certificados SSL, geolocalização, enriquecimento web/e-mail/hash/social e mais
• Transform Hub — navegue e instale transformações da comunidade a partir do registro
• Investigador IA — investigações agênticas orientadas por prompts que planejam execuções de transformações, transmitem progresso ao vivo e resumem descobertas com auditabilidade
• Importar / Exportar — importação nos formatos JSON, CSV, GraphML e MTGX
• Análise de grafos — centralidade, detecção de comunidades, caminhos mais curtos
• Colaboração em tempo real — projetos, compartilhamento e sincronização ao vivo via Supabase Realtime
• Trabalhos assíncronos de transformação — fila Redis/RQ com atualizações de progresso via WebSocket
• Sistema de plugins — descoberta de plugins baseada em diretórios com manifestos YAML
• Ferramenta CLI — pesquise, instale e gerencie transformações a partir do terminal
• Executa em qualquer lugar — modo SQLite local (zero configuração) ou PostgreSQL + Supabase para configurações em equipe/nuvem
• Pronto para Docker — implantação com um comando com docker compose up

Capturas de Tela

Início Rápido

Pré-requisitos

Ferramenta	Versão
Python	3.14+
uv	latest
Node.js	20+
pnpm	latest

Backend```bash

cd backend uv sync uv run uvicorn ogi.main:app --reload

A API estará disponível em `http://localhost:8000`.

Para execução local de transformação, o Redis e o worker de transformação também devem estar em execução. Apenas o Redis não é suficiente.

Iniciar Redis:```bash
docker run -d --name ogi-redis -p 6379:6379 redis:7-alpine

Inicie o worker de transformação em um segundo terminal:```bash cd backend uv run python -m ogi.worker.run_worker

Se vir `Job queue not available` ou `Redis not available`, verifique que:

- `OGI_REDIS_URL` aponta para `redis://localhost:6379/0` para execuções locais baseadas no host
- o backend foi reiniciado após o Redis estar disponível
- o processo worker separado está em execução
- não está a usar o nome de host exclusivo do Docker `redis` fora do Docker Compose

Se executar o backend contra PostgreSQL (`OGI_USE_SQLITE=false`), a inicialização aplicará automaticamente as migrações do Alembic antes de servir pedidos. As implantações Docker fazem o mesmo no ponto de entrada do container do backend.

As execuções do AI Investigator são processadas por outro worker separado:```bash
cd backend
uv run python -m ogi.agent.run_worker

Front-end```bash

cd frontend pnpm install pnpm dev

Abra http://localhost:5173. Só isso.

### Investigador de IA

O Investigador de IA é um fluxo de trabalho opcional apoiado por provedor que pode planejar sequências de transformação, solicitar aprovações e resumir o progresso da investigação dentro do espaço de trabalho.

- Abra a aba `Investigador de IA` dentro de um projeto
- Configure um provedor e modelo no diálogo de configurações do investigador
- Armazene chaves de API do provedor em `API Keys`
- Execute o processo separado `agent-worker` junto com o backend

A implementação atual suporta configuração de provedor por usuário e um worker dedicado que executa etapas de investigação independentemente do servidor principal da API.

### CLI

Duas formas suportadas de executar a CLI:

**Recomendado** (sem necessidade de ativação):```bash
cd backend
uv sync
uv run ogi --help

Ambiente virtual ativado (comando ogi simples):```bash cd backend uv venv

PowerShell:

..venv\Scripts\Activate.ps1 uv pip install -e . ogi --help

## Docker

### Desenvolvimento```bash
cp .env.example .env
docker compose up

Produção

Utilize as imagens GHCR pré-construídas.

Importante: docker-compose.prod.yml requer um banco de dados PostgreSQL externo. Ele não inclui um serviço db.

Se você quiser a stack Docker local all-in-one com Postgres e Redis integrados, use:```bash docker compose up -d

Use o arquivo compose de produção apenas quando você já tiver uma instância PostgreSQL acessível e tiver definido `OGI_DATABASE_URL` de acordo:```bash
docker compose -f docker-compose.prod.yml pull
docker compose -f docker-compose.prod.yml up -d

Defina OGI_IMAGE_TAG no .env para fixar uma tag de imagem de lançamento específica (ex.: v0.2.6). O padrão é latest.

Hetzner Cloud