Raims CLI

Use raims no terminal para consultar e gerenciar recursos da API pública, como clientes, cobranças, links de pagamento, saques e webhooks. Os comandos também funcionam em scripts e pipelines, com saída JSON e códigos de saída definidos.

Conecte sua conta pelo navegador com OAuth ou use uma chave de API para scripts e integrações. As requisições usam https://api.raims.com nos dois modos. A API confere a empresa, o ambiente, as permissões e as condições de cada recurso.

Instalar

Há pacotes para Windows (x64 e ARM64), Linux (x64 e ARM64) e macOS (x64 e ARM64). No Windows ARM64, use o Node.js ARM64 para instalar e executar o CLI nativo. Escolha o gerenciador de pacotes de sua preferência e instale o CLI globalmente:

npm install -g @raimshq/cli@latest

Após instalar o CLI, execute raims version para conferir a versão.

Os comandos da aba yarn usam Yarn Classic (1.x). Com Yarn 2 ou superior, execute yarn dlx @raimshq/cli@latest version; substitua version pelo comando desejado. Essa execução sob demanda dispensa a instalação global.

O npm seleciona o executável pela arquitetura do Node.js. Se tiver dúvidas, confira a arquitetura da instalação.

Instalação e atualização precisam de acesso à internet para obter o pacote. Os comandos da API precisam de acesso a api.raims.com; a consulta de guias precisa de acesso a docs.raims.com, exceto na leitura explícita do cache com --offline. Ajuda, mapa de comandos, perfis locais e doctor não exigem rede.

Para atualizar ou remover o CLI, use o mesmo gerenciador da instalação:

npm install -g @raimshq/cli@latest
npm uninstall -g @raimshq/cli

Em pipelines, obtenha a versão atual na etapa de instalação conforme CI e automação.

Instalações por gerenciadores de pacotes seguem a atualização do gerenciador e não ativam o atualizador da instalação direta.

A instalação direta oferece o executável nativo com atualizações próprias do CLI.

Descobrir comandos

Use raims --map para ver a árvore completa, com uma descrição de cada comando. Um grupo limita a consulta:

raims --map
raims charges --map=compact
raims --map=paths
raims --map=json

compact omite as descrições, paths lista os caminhos completos e json retorna a árvore em formato estruturado. O mapa não exige perfil, chave nem corpo e não executa os comandos apresentados.

Para preparar uma requisição, acrescente --help ao comando. Nos comandos com corpo JSON, a ajuda mostra os campos, os tipos, a obrigatoriedade, a aceitação de null e os valores permitidos. Os exemplos de invocação usam --dry-run; substitua os placeholders e revise o arquivo antes de enviar. Os exemplos de corpo, quando presentes, vêm da referência pública da API.

A ajuda reorganiza as colunas conforme a largura do terminal. Exemplos de comandos e JSON preservam seu conteúdo para você copiá-los; por isso, essas linhas podem ultrapassar a largura disponível. Em arquivos e pipes, a ajuda mantém a apresentação original.

Primeiros comandos

Comandos de criação e atualização recebem o corpo JSON por --data-file ou pelas flags de campos simples indicadas em --help. Consulte CI e automação para enviar arquivos, percorrer páginas e tratar resultados pendentes ou falhas. O grupo simulations executa as simulações permitidas pela API para a credencial e o recurso.

Consultar avisos e licenças

A partir da versão 0.1.1, raims licenses lê os avisos, licenças e termos de terceiros incluídos na versão em execução:

raims licenses
raims licenses --output json

Essa consulta é local e não exige perfil, chave ou rede. A saída JSON contém o texto em text e seu hash SHA-256 em sha256.

Consultar guias no terminal

Use raims docs search para encontrar orientações na documentação pública:

raims docs search "webhooks"
raims docs search "API keys" --language en --limit 5

Para ler um guia, informe seu caminho no site. Sem caminho, raims docs apresenta o guia do CLI:

raims docs /br/integracoes/webhooks
raims docs /en/cli --language en

Os comandos não exigem perfil ou chave. A busca usa o conteúdo público da Raims e pode ser capturada com --output json. --language br|en seleciona o idioma; o padrão é português. O caminho deve corresponder ao idioma escolhido. URLs externas e caminhos locais não são aceitos.

O conteúdo fica em cache por 24 horas. Use --refresh para buscar a versão mais recente ou --offline para consultar somente o cache, inclusive quando antigo. O resultado informa a origem e a idade do conteúdo. Sem cache, --offline termina com erro. As duas opções não podem ser combinadas; uma atualização que falhar não usa uma cópia antiga silenciosamente.

Abrir páginas oficiais

raims open lista atalhos para a documentação, a referência da API, o Dashboard, as chaves de API, os webhooks e o status da Raims. Para abrir a documentação do CLI:

raims open docs

Os destinos são fixos e o comando não aceita outra URL. Em CI, com --no-input ou sem um terminal, ele imprime o endereço sem iniciar um navegador. Use --output json para receber target, url e opened.

Escolha seu caminho

Perfis e credenciais

Um perfil pode usar uma sessão OAuth ou uma chave de API. No OAuth, o login acontece no navegador e a sessão fica protegida pelo armazenamento seguro do sistema. Para scripts, associe uma variável de ambiente à chave da API; o arquivo de perfis guarda somente o nome dessa variável.

Consulte Configuração e perfis para conectar, conferir o acesso, selecionar o ambiente e sair. Para credenciais de integração, consulte Chaves de API e Autenticação.