Lumo CLI

Tipo

Visão geral

Para

Desenvolvedor, Analista

O Lumo CLI é a linha de comando do Lumo, a plataforma de dados da HorusBI. Ele cria e altera Dataflows, tabelas, Cadastros, Aplicações e Dashboards de um Tenant (o ambiente de uma empresa no Lumo) editando arquivos YAML, e faz o mesmo que as telas fariam. Quem digita os comandos pode ser você ou um agente de IA, como Claude Code, Codex, Cursor ou OpenCode.

Como funciona

O lumo init baixa o Tenant para um diretório local, o workspace: um arquivo YAML por recurso, numa pasta por tipo (flows/, tables/, apps/ e assim por diante). Você edita os arquivos e manda as mudanças com lumo push. O servidor devolve a versão que gravou, com os campos que ele normalizou ou completou e sem os que ignorou, e o CLI reescreve o arquivo com ela, para que o YAML local fique igual ao que está no Tenant. O push lista essas diferenças campo a campo. O caminho contrário é o lumo pull, que traz para os arquivos o que mudou no servidor.

O push grava no servidor, mas não publica. Um Dataflow, uma Aplicação ou um Cadastro novo fica na Minha Mesa, visível só para quem criou, e só vai para uma Mesa quando alguém roda o comando de publicar daquele tipo, como lumo flow publish ou lumo app publish. O modelo completo, com o que acontece em cada comando, está em Conceitos.

O que ele gerencia

O lumo list aceita 13 tipos de recurso. Cada um tem uma página na referência YAML.

Tipo no YAML	Na plataforma	Pasta
flow	Dataflow	flows/
table	tabela do HorusDW	tables/
writeback	Cadastro	writebacks/
app	Aplicação, com os Dashboards dentro	apps/
credential	conexão com banco ou API	credentials/
schedule	agendamento de Dataflows	schedules/
agent	Agente ETL	agents/
dw-desk, bi-desk	Mesa de Dados, Mesa de Aplicação	dw-desks/, bi-desks/
deck, presentation	Deck e Apresentação	decks/, presentations/
investigation	Investigação	investigations/
variables	variáveis do Tenant	variables/tenant.yaml

Usuários, grupos e a criação de Tenants ficam fora: isso se faz no HEC ou pela API. O comando lumo template cuida de linhas de produto e Templates, assunto de Whitelabel.

Por que um CLI

Agentes de IA já leem e escrevem YAML e usam linha de comando sem treino extra, e leem o --help só do comando de que precisam. Como o trabalho vira arquivo, dá para guardar o workspace no Git e revisar o que o agente fez como se revisa código.

O MCP do Lumo faz outra coisa: deixa um assistente de IA consultar os dados das Aplicações, só para leitura. Para criar ou mudar recursos, o caminho é o Lumo CLI.

Por onde começar

Você quer	Comece por
Instalar e entrar no Tenant	Instalar o Lumo CLI
Usar com Claude Code, Codex, Cursor ou OpenCode	Agentes de código
Pedir trabalho a um agente e conferir o resultado	Trabalhar com IA
Entender workspace, push, pull e publicação	Conceitos
Rodar o CLI numa esteira de CI	Lumo CLI em CI
Resolver um push recusado por drift ou conflito	Drift e conflitos
Consultar um comando ou uma chave de YAML	Comandos e referência YAML