@kruzer/cli

A CLI @kruzer/cli é a interface oficial para interagir com o DevTools Kruzer diretamente do seu terminal. Ela facilita a configuração do ambiente, autenticação, seleção de tenants e execução de automações escritas em TypeScript.

Instalação

Adicione o IDK no seu projeto via npm:

npm install -g @kruzer/cli

Comandos disponíveis

krz configure

Este comando inicia o processo de configuração da CLI na sua máquina local.

  • Fluxo:
    1. Solicita a URL do ambiente Kruzer (exemplo: https://devtools.instance.krzlabs.io).
    2. Solicita o usuário e a senha.
    3. Configura as credenciais localmente para autenticação automática em comandos subsequentes.

Após a execução, seu usuário estará autenticado e pronto para usar os demais comandos da CLI.

krz login

Use este comando para realizar login manual na plataforma Kruzer, caso não tenha feito pelo krz configure ou queira trocar o usuário autenticado.

  • Ele solicita suas credenciais (usuário e senha).
  • Atualiza o token de acesso local para autenticação das operações futuras.

krz select tenant

Permite selecionar um ou mais tenants que você utilizará para suas integrações.

  • A seleção dos tenants é necessária para garantir que as credenciais corretas sejam usadas nas integrações.
  • Se nenhum tenant for selecionado, as integrações podem falhar por erro de autorização nos Data Sources.

Importante: Sempre confirme que o tenant correto está ativo antes de rodar automações.

krz run <nome-do-arquivo>

Executa um arquivo de automação escrito em TypeScript.

  • Compila o arquivo .ts especificado.
  • Gera o build necessário para execução.
  • Executa o código da automação no ambiente local.

Exemplo:

krz run updateInventory.ts

Boas práticas

  • Sempre use krz configure para configurar seu ambiente antes de qualquer operação.
  • Utilize krz select tenant para garantir que está operando com as credenciais corretas.
  • Automatize suas tarefas usando arquivos TypeScript e execute com krz run para garantir consistência.
  • Consulte a documentação oficial para exemplos avançados e uso de flags adicionais.

Se precisar de ajuda com algum comando, utilize:

krz --help

Copyright © 2025 kruzer | All Rights Reserved