Documentação HorusBI
Buscar K

Aparência

Abrir no Claude Abrir no ChatGPT

Lumo CLI ​

O Lumo CLI é a interface de linha de comando oficial da plataforma HorusBI. Ele transforma qualquer diretório local em um workspace declarativo de um tenant — uma cópia espelho do tenant em arquivos YAML que você lê, edita e sincroniza com o servidor.

NOTE

O Lumo é voltado para administradores e desenvolvedores que gerenciam recursos de um tenant HorusBI (flows, tabelas DW, aplicações BI, agendamentos, credenciais, agentes e mesas) de forma programática, versionada e auditável.

🤖 Feito para agentes de IA ​

O Lumo nasceu como o modo headless do HorusBI — uma forma de agentes de IA (Claude Code, Codex e afins) operarem a plataforma por conta própria: criar flows, modelar o DW, montar dashboards e exportar resultados, tudo via comandos e YAML.

Você descreve a intenção em linguagem natural e o agente traduz para os comandos certos do lumo. Para isso, publicamos uma skill pronta a cada release.

➡️ Integrações com IA — instale a skill no Claude Code, Codex ou outro agente. ➡️ Trabalhando com a IA — o que é seu, o que é da IA, e como pedir as coisas.

⚙️ Como funciona ​

Você trabalha com arquivos YAML que representam os recursos do seu tenant. O ciclo é direto: edite os arquivos localmente, envie ao servidor com push, e traga o que está no servidor com pull.

bash
lumo status            # ver o que mudou localmente
# editar YAML em flows/, tables/, apps/, ...
lumo push              # aplicar as mudanças no servidor

Depois do push, seus arquivos são atualizados para refletir exatamente o que ficou salvo no servidor.

🗂️ Recursos Gerenciados ​

O Lumo gerencia os seguintes tipos de recursos de um tenant HorusBI:

RecursoPastaDescrição
flowflows/Pipelines ETL
tabletables/Tabelas do Data Warehouse
appapps/Aplicações BI e dashboards
credentialcredentials/Conexões e credenciais
scheduleschedules/Agendamentos
agentagents/Agentes de execução
dw-deskdw-desks/Mesas de dados (flows + tabelas)
bi-deskbi-desks/Mesas de aplicação (apps)
variablesvariables/Variáveis do tenant

NOTE

O que o Lumo CLI não cobre: gestão de usuários e grupos, criação e provisionamento de tenants e demais configurações administrativas do tenant continuam sendo feitas pela interface HEC ou pela API. O Lumo CLI foca nos recursos de dados e BI listados acima.

🧭 Por que um CLI (e não um MCP)? ​

Quando desenhamos o modo headless, a escolha natural seria expor um servidor MCP. Optamos por um CLI + YAML de propósito — e por bons motivos:

  • Acurácia. LLMs já viram milhões de exemplos de uso de CLIs e de arquivos YAML no treino. É um terreno conhecido: o agente erra menos seguindo lumo push e editando YAML do que aprendendo um conjunto de ferramentas custom do zero.
  • Economia de tokens. Um MCP tende a injetar o schema de todas as ferramentas no contexto a cada sessão. Com o CLI, o agente lê só o --help do comando que precisa, quando precisa — e a saída é texto compacto. Menos contexto gasto, mais espaço para o raciocínio.
  • Componibilidade. O agente combina o lumo com o resto do shell — grep, git, pipes, scripts. Todo o ecossistema de linha de comando vira ferramenta, sem integração extra.
  • Versionável e auditável. Os YAMLs vivem em Git, exatamente como um humano faria. Diffs revisáveis, histórico, rollback — o trabalho do agente fica rastreável.
  • Sem processo extra. Não há servidor MCP para subir e manter vivo: o lumo é invocado sob demanda e termina. Mais simples de operar em CI e em máquinas efêmeras.

Em resumo: ao falar a língua que os modelos já dominam (CLI e YAML), ganhamos precisão e economia sem abrir mão de auditabilidade.

📚 Estrutura da Documentação ​

🚀 Começar Rápido ​

bash
# 1. Instalar (macOS/Linux)
curl -fsSL https://storage.horusbi.com.br/download/lumo/install.sh | bash

# 2. Autenticar
lumo auth login

# 3. Inicializar workspace
lumo init <tenant-id>

# 4. Ver status e editar
lumo status
# edite os YAMLs em flows/, tables/, apps/, ...

# 5. Enviar mudanças
lumo push

Veja o guia completo em Primeiros Passos.