Reportei CLI

Interface de terminal para a plataforma Reportei. Gerencie projetos, relatórios, dashboards, integrações, métricas e mais — tudo pela linha de comando.

Construído sobre o Model Context Protocol (MCP) via Streamable HTTP, o CLI se comunica com o mesmo servidor que alimenta as integrações de IA do Reportei.

Recursos

Instalação

Instale o CLI globalmente via npm para ter o comando reportei disponível em todo o sistema.

Pré-requisitos

• Node.js >= 20.0.0
• npm (incluso com Node.js)
• Uma conta Reportei com pelo menos uma integração conectada

Passos de Instalação

Instalação Global

A instalação global é a forma recomendada para usar o CLI:

npm install -g @reportei/cli

# Verify installation
reportei --version

Usando com npx

Alternativamente, execute sem instalar usando npx:

npx @reportei/cli projects list

Autenticação

O CLI autentica via OAuth 2.0 Device Authorization Grant — o mesmo fluxo seguro usado por ferramentas como o GitHub CLI. Nenhuma senha é digitada no terminal.

Como Funciona

Login

Inicie o fluxo de autenticação:

reportei auth login

Verificar Status

Verifique o estado atual da autenticação:

reportei auth status

Logout

Remova o token armazenado:

reportei auth logout

Login com Perfil

Autentique em um perfil específico:

reportei --profile staging auth login

Comandos Disponíveis

O CLI organiza seus comandos por domínio. Cada comando pode ter subcomandos e opções específicas.

Uso

Opções Globais

Configuração

Gerencie perfis, formatos de saída e projeto padrão através do comando config.

Gerenciar Configurações

Use o comando config para visualizar e alterar configurações:

# View current configuration
reportei config list

# Set output format
reportei config set output_format json

# Get a specific setting
reportei config get output_format

Perfis

O CLI suporta múltiplos perfis para alternar entre contas ou ambientes:

# Login to a different profile
reportei --profile staging auth login

# Set the default profile
reportei config default staging

# List all profiles
reportei config profiles

Projeto Padrão

Defina um projeto padrão para evitar passar --project-id em cada comando:

# Set a default project
reportei project use 42

# Check current project
reportei project current

# Clear default project
reportei project clear

Formatos de Saída

Todos os comandos de listagem e exibição suportam quatro modos de saída:

Exemplo: Saída em Tabela

Formato padrão, otimizado para leitura humana:

reportei projects list

Exemplo: Saída em JSON

Formato estruturado, ideal para scripts e integração:

reportei projects list --json

Exemplo: Saída em CSV

Formato para exportação para planilhas:

reportei projects list --csv > projects.csv

Exemplo: Pipe com jq

Combine com ferramentas Unix para processamento avançado:

reportei projects list --json | jq '.[].name'

Modo Interativo

O modo interativo oferece um shell REPL completo onde você pode executar comandos sem o prefixo reportei, com auto-completar, histórico e prompt contextual.

Iniciar o Modo Interativo

Execute o comando abaixo para entrar no shell interativo:

reportei interactive

Recursos do Modo Interativo

Exemplo de Sessão

Uma sessão típica no modo interativo:

reportei> projects list
reportei> project use 42
reportei [project:42]> integrations list
reportei [project:42]> metrics list --integration-slug instagram_business
reportei [project:42]> reports create
reportei [project:42]> exit

Exemplos de Uso

Fluxos de trabalho comuns que você pode realizar com o CLI do Reportei.

Perguntas Frequentes