Buscar K
Aparência
Comandos do Lumo CLI
- Tipo
- Referência
- Para
- Desenvolvedor
A lista abaixo sai do código do Lumo CLI (o Use, o Short e as flags de cada comando), e não há outra lista de comandos nesta documentação. lumo <comando> --help explica cada flag com exemplos.
Os comandos apontam para recursos no formato tipo:id (flow:5101, app:7302). A ordem em que eles aparecem no trabalho, e o que cada comando de sincronização faz, está em Conceitos.
Todos os comandos
| Comando | Descrição | Flags |
|---|---|---|
lumo access | Conferência de acesso: quem enxerga o quê | - |
lumo access check | Confere o acesso de pessoas a apps | --user --app |
lumo agent | Agent management & investigation: link, restart, migrate, events, health | - |
lumo agent events <agent:id> | List problem schedule-events for an agent (missed/late/error/crashed) | --window --since --until --status --recovered --acknowledged --all |
lumo agent health <agent:id> | Show the agent's 24h health pulse (uptime, memory, jobs, queue, timeline) | --range --full --mac |
lumo agent link | Link an external agent to this tenant via its token | --token --name |
lumo agent migrate | Bulk-rebind flows and credentials to another agent | --flows --credentials --to-agent --force |
lumo agent restart <agent:id> | Force a remote agent to restart | - |
lumo app | BI app operations: query, export, open | - |
lumo app change-table <app:id> | Swap a table reference inside an app to a compatible one | --from-table --to-table --dry-run --force |
lumo app clone <app:id> | Clone an app under a new name | --name |
lumo app dashboard-preview <app:id> | Run each widget's query and return data + visual JSON (no PNG render) | --dashboard --widget --filter --limit --sql-only --debug-sql |
lumo app export <app:id> | Export a dashboard as PNG/PDF/SVG | --dashboard --image-format --output --dark-theme --landscape --timeout --as |
lumo app export-widget <app:id> | Export a single widget as PNG | --dashboard --widget --image-format --output --dark-theme --as |
lumo app open <app:id> | Open the app in the browser, or print a link (plain or one-use logged-in) | --no-browser --dashboard --session |
lumo app publish <app:id> | Publish an app to a desk (drift-protected via If-Match) | --desk --new --force --yes |
lumo app query <app:id> | Run a BI engine query against an app | --fields --filter --order-by --limit --sql-only --as |
lumo app widgets <app:id> | List an app's widgets - discover {appId, widgetGuid} pairs for deck authoring | - |
lumo auth | Authentication commands | - |
lumo auth login | Log in to Horus BI | --email --password --otp --web --web-url --local |
lumo auth logout | Log out and clear stored credentials | - |
lumo auth status | Show current authentication status | - |
lumo backup | Snapshot the local workspace as a tar.gz | --output --exclude-state |
lumo columns <table:id> | List the columns of a DW table | - |
lumo credential | Credential operations: test, query, schema, transfer, move-flows | - |
lumo credential move-flows <credential:id> --to <credential:id> | Move every flow node from one connection to another of the same agent | --to --flows --dry-run --force --yes |
lumo credential query <credential:id> | Run an ad-hoc SQL query against the source | --sql --limit --timeout |
lumo credential schema <credential:id> | List schemas / tables / columns visible through this credential | --schema --timeout |
lumo credential test <credential:id> | Test connectivity to the source via its agent | - |
lumo credential transfer <credential:id> | Rebind the credential to a different agent | --to-agent |
lumo deck | Presentation deck operations: publish, unpublish, url, check, export, preview, open | - |
lumo deck check <deck:id> | Verify a deck's public kiosk link resolves | - |
lumo deck export <deck:id> | Export a deck as PDF/PNG | --format --range --slide --count --margin --output |
lumo deck open <deck:id> | Open the deck editor in the browser (or print the URL) | --no-browser |
lumo deck preview <deck:id> | Smoke-check every chart element in the deck against real data | - |
lumo deck publish <deck:id> | Put a deck on the kiosk and print its public /p/<sqid> URL | --seconds |
lumo deck unpublish <deck:id> | Take a deck's public kiosk URL offline | - |
lumo deck url <deck:id> | Print a deck's public kiosk URL and publish state (read-only) | - |
lumo diff <resource> | Show diff between WORKING / STATE / SERVER | --include-remote --field |
lumo fetch [resource...] | Refresh STATE from the server (does not modify WORKING) | --parallel --full |
lumo flow | Imperative flow operations: clone, publish, run, node-level execution | - |
lumo flow cancel | Cancel a running flow execution | --execution --force |
lumo flow clone <flow:id> | Clone a flow under a new name | --name --dry-run |
lumo flow export-node <flow:id> | Export a node's output as a downloadable artifact | --node |
lumo flow force-batch | Dispatch a batch of flows in dependency order (a template apply's reloadPlan) | --from-reload-plan |
lumo flow logs <flow:id> | Show execution history for a flow | --since --until --success --failed --all --tail |
lumo flow nodes <flow:id> | List nodes of a flow (internalId + kind + description) for run-node lookup | --type |
lumo flow preview-node <flow:id> | Preview a node's output rows without writing | --node |
lumo flow publish <flow:id> | Publish a flow to a desk (drift-protected via If-Match) | --desk --new --copy-data --dry-run |
lumo flow run <flow:id> | Trigger a flow execution | --wait --follow --context --temporal-days |
lumo flow run-node <flow:id> | Execute a single node (write side-effects) | --node --follow |
lumo flow status <flow:id> | Show runtime status for a flow (running / idle / queued) | - |
lumo flow sync-table <flow:id> | Create or sync a flow's DW table from its InsertDatawarehouse node | --node --name --force --yes |
lumo group | Gestão de grupos do tenant: list, show, apply, membros e concessões | - |
lumo group add-member <group> <user>... | Adiciona usuários a um grupo | - |
lumo group apply -f <arquivo|-> | Aplica o documento de acesso (YAML ou JSON) ao grupo | --file --dry-run --force --yes |
lumo group block <group> <ref> | Bloqueia um app | - |
lumo group create <nome> | Cria um grupo e imprime o id | - |
lumo group delete <group> | Exclui um grupo | --force --yes |
lumo group grant <group> <ref> | Concede acesso a um recurso | --filtro --colunas-ocultas --sem-exportar --esconder-sem-ligacao --validade --escrita |
lumo group list | Lista os grupos do tenant | - |
lumo group remove-member <group> <user>... | Remove usuários de um grupo | - |
lumo group rename <group> <nome> | Renomeia um grupo | - |
lumo group revoke <group> <ref> | Retira o acesso a um recurso | - |
lumo group show <group> | Mostra o acesso de um grupo | --output --secao |
lumo group unblock <group> <ref> | Desbloqueia um app | - |
lumo info <flow|table|app|credential|dw-desk|bi-desk|schedule|agent|deck>:<id> | Show read-only metadata and runtime status for a resource | --full --dependents --key-check --field |
lumo init <tenant-id> [<dir>] | Bootstrap a workspace for a Horus BI tenant | --recover --fetch-only |
lumo investigation | Sentinela investigation operations: runners, publish, run, findings | - |
lumo investigation findings <investigation:id> | List occurrences (achados) from an investigation's last finished round | - |
lumo investigation publish <investigation:id> | Publish a personal investigation to the rest of the tenant (one-way) | - |
lumo investigation run <investigation:id> | Enqueue a one-shot round for an investigation | - |
lumo investigation runners | List the check types (runners) and the config fields each one takes | - |
lumo lint [file...] | Validate dual-document YAML files against the v2 schemas | --strict |
lumo list <kind> | List resources of a kind (flow, table, writeback, app, credential, dw-desk, bi-desk, schedule, agent, deck, presentation, investigation, variables) | --search --desk --remote --limit --offset |
lumo log [resource] | Show audit log of sync operations | --count --limit --since --operation --errors |
lumo new <flow|table|app|credential|schedule|dw-desk|bi-desk|deck|presentation|investigation> | Create a new resource on the server (eager: server-first → STATE → WORKING) | - |
lumo new app | Create a new BI application | --name --table |
lumo new bi-desk | Create a new application desk (publish target for apps) | --name |
lumo new credential | Create a new HEC credential | --name --type |
lumo new deck | Create a new presentation deck | --name |
lumo new dw-desk | Create a new data desk (publish target for flows / tables) | --name |
lumo new flow | Create a new flow | --name --load-type |
lumo new investigation | Create a new Sentinela investigation | --name --question |
lumo new presentation | Create a new presentation (kiosk playlist) | --name |
lumo new schedule | Create a new schedule | --name --cron --agent |
lumo new table | Create a new DW table - must combine --from-flow + --node (workflow C) | --name --from-flow --node --from-node --table-type |
lumo new writeback | Create a writeback table (rows typed by people in the web UI, not produced by a flow) | --name --from-file |
lumo presentation | Presentation (kiosk) operations: publish, unpublish, check, open | - |
lumo presentation check <presentation:id> | Verify a presentation kiosk's public link resolves | - |
lumo presentation open <presentation:id> | Open the presentation editor in the browser (or print the URL) | --no-browser |
lumo presentation publish <presentation:id> | Publish a presentation kiosk to its public /p/<sqid> URL | - |
lumo presentation unpublish <presentation:id> | Take a presentation kiosk's public URL offline | - |
lumo pull [resource...] | Refresh STATE then overwrite WORKING with the cached payload | --discard-local --no-fetch --parallel --dry-run --prune |
lumo push [resource...] | Save local edits to the server | --dry-run --no-lint --parallel --continue-on-error --force-ours --i-know-what-im-doing --force-recreate --rename --allow-drop |
lumo rm <flow|table|writeback|app|credential|schedule|dw-desk|bi-desk|agent|deck|presentation|investigation>:<id> | Delete a resource on the server and locally | --force --yes --cascade --dry-run |
lumo scaffold [<kind> [<variant>]] | Print embedded YAML reference + examples for any Lumo kind | - |
lumo scaffold ls | Flat list of every embedded scaffold (kind.variant - tagline) | - |
lumo schedule | Schedule operations: run, pause, resume, logs | - |
lumo schedule logs <schedule:id> | List recent trigger executions for a schedule | --since --tail |
lumo schedule pause <schedule:id> | Pause a schedule (sets ativo=false) | - |
lumo schedule resume <schedule:id> | Resume a schedule (sets ativo=true) | - |
lumo schedule run <schedule:id> | Trigger a schedule one-shot | - |
lumo status | Show local-modified, deleted, and untracked resources | --summary --filter |
lumo table | Table operations: truncate, preview | - |
lumo table clone <table:id> | (not supported) - clone the FLOW that owns the table instead | - |
lumo table preview <table:id> | Preview rows from the DW table | --limit |
lumo table truncate <table:id> | Remove all rows from the DW table (schema preserved) | --force --yes --dry-run |
lumo template | Product lines and templates: list, inspect, create, release versions, install | - |
lumo template apply --product-line <id> [--outdated | --tenant <tenant>...] | Install a product line in tenants (current template by default) | --product-line --outdated --tenant --template --etl-agent --connection --dry-run --mirror --change-line --overwrite --downgrade --partial-agents --confirm --force --yes |
lumo template bump-version --product-line <id> | Release a new version of a product line from its base tenant | --product-line --from --add-app --remove-app --add-investigation --remove-investigation --add-ai-agent --remove-ai-agent --notes --changelog-title --changelog-body --current --dry-run --force --yes |
lumo template changelog | Changelog entries of a product line | - |
lumo template changelog add --product-line <id> --template <template> --title <text> --body <file.md|-> | Add a changelog entry tied to a template | --product-line --template --title --body |
lumo template changelog delete <changelog> | Delete a changelog entry | --force --yes |
lumo template changelog edit <changelog> [--title <text>] [--body <file.md|->] | Edit the title or body of a changelog entry (the version stays) | --title --body |
lumo template create --product-line <id> --name <name> | Create a template (v0.0.1) from the workspace tenant, inside a product line | --product-line --name --description --app --investigation --ai-agent --notes --changelog-title --changelog-body --current --dry-run --force --yes |
lumo template delete <template> | Delete a template (soft delete) | --force --yes |
lumo template diff <template-a> <template-b> | What changes from one template version to another | - |
lumo template docs | Product line documentation (the web Documentation tab) | - |
lumo template docs set --product-line <id> --file <doc.md|doc.html|-> | Replace the product line documentation | --product-line --file --dry-run --force --yes |
lumo template docs show --product-line <id> | Print the product line documentation as Markdown | --product-line |
lumo template inspect --product-line <id> | Everything about one product line | --product-line |
lumo template link <template> --product-line <id> | Link an unlinked template to a product line | --product-line |
lumo template list | List the product lines of the workspace client, with their templates | --search --installed |
lumo template product-line | Create and edit product lines | - |
lumo template product-line create --name <name> | Create a product line in the client of the workspace tenant | --name --mode --description --tag --dry-run --force --yes |
lumo template product-line edit <product-line> | Edit name, description, tags or mode of a product line | --name --mode --description --tag --dry-run --force --yes |
lumo template set-current <template> | Make a template the current one of its product line | --force --yes |
lumo template show <template> | What one template version carries (names and counts, never values) | - |
lumo tenants | Tenant discovery | - |
lumo tenants list | List tenants available to the authenticated user | - |
lumo update | Atualiza o lumo para a última versão (binário + skills) | --check |
lumo user | Gestão de usuários do tenant: list, show, apply, convites e concessões | - |
lumo user apply -f <arquivo|-> | Aplica o documento de acesso (YAML ou JSON) ao usuário | --file --dry-run --force --yes |
lumo user block <user> <ref> | Bloqueia um app | - |
lumo user deactivate <user> | Inativa um usuário e remove seus acessos | --force --yes |
lumo user grant <user> <ref> | Concede acesso a um recurso | --filtro --colunas-ocultas --sem-exportar --esconder-sem-ligacao --validade --escrita |
lumo user invite <email> | Convida (ou reativa) um usuário pelo e-mail | --nome --grupo --sem-email |
lumo user list | Lista os usuários do tenant | --grupo --inativos |
lumo user reactivate <user> | Reativa um usuário inativo | --grupo |
lumo user revoke <user> <ref> | Retira o acesso a um recurso | - |
lumo user send-password <user> | Envia ao usuário o e-mail para definir a senha | - |
lumo user show <user> | Mostra o acesso de um usuário | --output --secao |
lumo user unblock <user> <ref> | Desbloqueia um app | - |
lumo variables | Tenant variable operations: list, get, set, unset | - |
lumo variables get <key> | Read one variable by key | --remote |
lumo variables list | List all tenant variables | --remote |
lumo variables set <key>=<value> | Create or update a tenant variable | --from-stdin |
lumo variables unset <key> | Remove a tenant variable | - |
lumo version | Print build information | - |
lumo writeback | Writeback (Cadastro) operations: publish, preview, import, imports, rollback-import, export | - |
lumo writeback export <writeback:id> | Download every visible row of a writeback (Cadastro) as XLSX | --output |
lumo writeback import <writeback:id> <file.xlsx> | Bulk-load rows into a writeback (Cadastro) from an XLSX file | --mode --no-wait |
lumo writeback imports <writeback:id> | List import batches for a writeback (Cadastro) | - |
lumo writeback preview <writeback:id> | Preview rows from a writeback's DW mirror | --fields --filter --sort --limit |
lumo writeback publish <writeback:id> | Publish a writeback (Cadastro) to a dw-desk | --desk |
lumo writeback rollback-import <writeback:id> <importId> | Undo an import batch, restoring what it superseded | --force --yes |
Códigos de saída
| Código | Significado | Primeira ação |
|---|---|---|
| 0 | Sucesso, inclusive "nada a fazer" e push parcial | Nenhuma. No push parcial, leia a lista Ignored by server |
| 1 | Erro genérico. No lumo diff, quer dizer "há diferença", como no diff do Unix | Leia a mensagem. Vindo do diff, é resultado |
| 2 | Uso errado: argumento ou flag faltando, confirmação exigida com --no-input | lumo <comando> --help |
| 3 | Drift: o servidor mudou desde a última sincronização | Drift e conflitos |
| 4 | Conflito: o pull encontrou edição local, ou o servidor respondeu 409 | Drift e conflitos |
| 5 | Recurso não encontrado | Confira o tipo:id; talvez lumo fetch |
| 6 | Sessão ou acesso | lumo auth login; se o acesso ao Tenant mudou, lumo init <tenant-id> --recover |
| 7 | Rede ou tempo esgotado | Repita o comando |
| 8 | lumo lint encontrou erro | Corrija o YAML no caminho indicado |
| 9 | O servidor recusou o conteúdo, ou o recurso está publicado | Leia a mensagem; recurso publicado pede clone |
| 10 | Erro do servidor (5xx) | Tente uma vez; se persistir, reporte |
| 11 | Workspace já existe no diretório, ou ligado a outro Tenant (só o lumo init) | Outro diretório, ou lumo init <tenant-id> --recover |
| 12 | O recurso não tem cache local | lumo fetch <tipo>:<id> |
| 13 | lumo rm bloqueado por dependentes | --cascade, ou remova os dependentes antes |
| 14 | Pré-condição: outra escrita chegou antes, ou o push de um Cadastro apagaria um campo | Drift e conflitos |
| 20 | lumo update precisa de privilégio | Rode o que o comando imprime, como sudo lumo update |
| 21 | lumo update falhou (rede, checksum, arquivo) | Repita; se persistir, confira a conexão |
Os comandos de leitura (status, info, list, columns, diff, log, fetch) podem ser repetidos sem risco. Os que mudam o servidor (new, push, clone, publish, run, rm, truncate) não: depois de uma falha, confira o estado antes de repetir.
Flags globais
Valem para qualquer comando.
| Flag | Descrição |
|---|---|
--debug | verbose debug output to stderr |
--format | output format: text | json | yaml (yaml is honored by info and diff; other commands fall back to text or json) |
--no-color | disable colored output |
--no-input | disable interactive prompts |
--server | API base URL (overrides workspace.json) |
--workspace | workspace path (default: walk up from PWD) |
Todo comando aceita também --help (-h).