Pular para o conteúdo principal

Uso

Sintaxe​

kobana <produto> <recurso> <metodo> [flags]
  • <produto> — banking, finance, billing, inbox, dunning, dashboards ou kadu.
  • <recurso> — pode ser aninhado: tasks, executions search, webhook-deliveries. É o primeiro segmento depois de /v1, com - no lugar de _.
  • <metodo> — a ação: list, get, create, update, delete, ou o nome da ação do endpoint (run, cancel, replay).

A versão da API nunca entra no comando — o CLI resolve a URL a partir da spec OpenAPI embutida.

Parâmetros de URL e de query vão em --params; o corpo da requisição vai em --json. O CLI sabe pela especificação onde cada parâmetro vai: id entra no caminho, o resto na query.

Toda a superfície é descoberta pelo --help, em qualquer nível:

kobana --help                       # products
kobana kadu --help                  # Kadu resources
kobana kadu tasks --help            # methods of a resource

Recursos de kadu​

RecursoDescrição
meQuem está por trás do token.
organizationsA organização do token: nome, fuso, teto mensal de custo e custom_metadata.
workspacesDomínios de negócio da organização. Cada workspace é um plugin do Kadu Playbook.
activitiesAgrupadores de tarefas dentro de um workspace.
tasksAs skills executáveis da organização: cadastro, disparo, pré-checagem e o endpoint HTTP de disparo.
executionsCada disparo de uma tarefa, com logs, eventos, pendências e busca textual.
memoriesMemória da organização: registros por entidade (entity_type + entity_value), no escopo da organização, de um workspace ou de uma atividade.
environmentsAmbientes de execução (Produção, Sandbox…). Cada secret e agendamento pertence a um.
secretsCredenciais entregues às execuções. O valor é gravado cifrado e nunca é devolvido.
schedulesExecuções recorrentes de uma tarefa num ambiente, por expressão cron.
filesArquivos de entrada (anexados ao disparo) e de saída (publicados pela execução).
repositoryO Kadu Playbook da organização e a sincronização dele.
usageTokens, custo e preço das execuções.
todosPendências criadas pelas execuções.
webhooksNotificações HTTP assinadas enviadas quando eventos acontecem.
webhook-deliveriesHistórico e reenvio das entregas de webhook.
operation-approvalsOperações pedidas por um assistente pelo MCP que esperam a confirmação da pessoa pelo link (só leitura).
rolesPapéis e as permissões agent.* que concedem.
usersMembros da organização.
membershipsVínculos de pessoas com a organização.
system-eventsEventos da organização (os mesmos que alimentam os webhooks).

Cada recurso tem a sua própria página, com a tabela completa de comandos e exemplos — veja o catálogo.

Exemplos​

# Execuções que falharam ou foram canceladas no mês
kobana kadu executions list \
  --params '{"status[in]": "failed,cancelled", "reference_date[gte]": "2026-10-01"}' \
  --fields "id,status,reference_date"

# Todas as páginas, um item por linha (NDJSON)
kobana kadu executions list --page-all --fields "id,status"

# Saída em tabela
kobana kadu tasks list --output-format table

# Salvar a resposta em arquivo
kobana kadu tasks get --params '{"id": "TASK_ID"}' --output tarefa.json

Exemplo: disparar e acompanhar​

# 1. A tarefa e o ambiente
kobana kadu tasks list --fields "id,skill_slug,label"
kobana kadu environments list --fields "id,label"

# 2. Conferir se o ambiente está pronto
kobana kadu tasks readiness --params '{"id": "TASK_ID"}'

# 3. Disparar (primeiro com --dry-run)
kobana kadu tasks run --dry-run --params '{"id": "TASK_ID"}' \
  --json '{"reference_date": "2026-10-30", "environment_id": "ENVIRONMENT_ID"}'

# 4. Acompanhar a execução
kobana kadu executions get --params '{"id": "EXECUTION_ID"}' --fields "id,status"
kobana kadu executions events --params '{"id": "EXECUTION_ID"}'
kobana kadu executions logs --params '{"id": "EXECUTION_ID"}'

# 5. Resolver as pendências que ela deixou
kobana kadu executions todos --params '{"id": "EXECUTION_ID"}'
kobana kadu todos update --params '{"id": "TODO_ID"}' --json '{"status": "resolved"}'

Próximos passos​