Referência dos comandos | Documentação da Raims

--color string padrão: auto
- Cores no terminal: auto, on ou off. JSON e scripts de autocompletar continuam sem cores.
--debug bool padrão: false
- Envia eventos de diagnóstico em JSON para stderr, sem credenciais nem argumentos do comando.
--environment string padrão: vazio
- Selecione sandbox ou production para OAuth ou uma prévia OAuth; a chave de API define o próprio ambiente.
--help, -h bool padrão: false
- Exibe a ajuda de raims.
--map string padrão: vazio
- Liste a árvore de comandos sem executar uma ação: tree, compact, paths ou json.
--no-input bool padrão: false
- Desativa perguntas durante a execução; também se aplica em CI e quando não há um terminal.
--output, -o string padrão: text
- Formato da saída: text ou json.
--profile string padrão: vazio
- Usa um perfil neste comando, com prioridade sobre RAIMS_PROFILE e o padrão salvo.
--version, -v bool padrão: false
- Exibe a versão de raims.

Exemplo do comando

Shell

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

Subcomandos: raims accounts, raims auth, raims balances, raims charges, raims completion, raims config, raims customers, raims disputes, raims docs, raims doctor, raims help, raims licenses, raims login, raims logout, raims mcp, raims open, raims payment-links, raims profile, raims refunds, raims simulations, raims statements, raims update, raims version, raims webhook-event-types, raims webhooks, raims withdrawal-destinations, raims withdrawals.

`raims auth`

Confira a autenticação na API com o perfil selecionado.

Shell

raims auth [flags]

--help, -h bool padrão: false
- Exibe a ajuda de auth.

Subcomandos: raims auth check, raims auth status.

`raims auth check`

Valide a credencial selecionada com uma consulta de leitura da conta.

Shell

raims auth check [flags]

--help, -h bool padrão: false
- Exibe a ajuda de check.
--show-headers bool padrão: false
- Mostre os headers públicos da resposta, sem credenciais ou cookies.
--timeout duration padrão: 1m0s
- Prazo total da requisição, incluindo novas tentativas e esperas.

Validate the selected profile's API key or OAuth session with GET /v1/accounts/fees at https://api.raims.com. A successful check confirms access to this endpoint; other requests retain their own authorization and eligibility rules.

`raims auth status`

Consulte os metadados locais de autenticação sem ler credenciais nem acessar a rede.

Shell

raims auth status [flags]

--help, -h bool padrão: false
- Exibe a ajuda de status.

`raims completion`

Gera o script de autocompletar para o terminal escolhido.

Shell

raims completion [flags]

--help, -h bool padrão: false
- Exibe a ajuda de completion.

Subcomandos: raims completion bash, raims completion fish, raims completion powershell, raims completion setup, raims completion zsh.

`raims completion bash`

Gera o script de autocompletar para Bash.

Shell

raims completion bash

--help, -h bool padrão: false
- Exibe a ajuda de bash.
--no-descriptions bool padrão: false
- Omite as descrições nas sugestões de autocompletar.

Generate the autocompletion script for the bash shell.

This script depends on the 'bash-completion' package.
If it is not installed already, you can install it via your OS's package manager.

To load completions in your current shell session:

    source <(raims completion bash)

To load completions for every new session, execute once:

#### Linux:

    raims completion bash > /etc/bash_completion.d/raims

#### macOS:

    raims completion bash > $(brew --prefix)/etc/bash_completion.d/raims

You will need to start a new shell for this setup to take effect.

`raims completion fish`

Gera o script de autocompletar para Fish.

Shell

raims completion fish [flags]

--help, -h bool padrão: false
- Exibe a ajuda de fish.
--no-descriptions bool padrão: false
- Omite as descrições nas sugestões de autocompletar.

Generate the autocompletion script for the fish shell.

To load completions in your current shell session:

    raims completion fish | source

To load completions for every new session, execute once:

    raims completion fish > ~/.config/fish/completions/raims.fish

You will need to start a new shell for this setup to take effect.

`raims completion powershell`

Gera o script de autocompletar para PowerShell.

Shell

raims completion powershell [flags]

--help, -h bool padrão: false
- Exibe a ajuda de powershell.
--no-descriptions bool padrão: false
- Omite as descrições nas sugestões de autocompletar.

Generate the autocompletion script for powershell.

To load completions in your current shell session:

    raims completion powershell | Out-String | Invoke-Expression

To load completions for every new session, add the output of the above command
to your powershell profile.

`raims completion setup`

Veja o plano de autocompletar ou salve um novo script.

Shell

raims completion setup [flags]

--dry-run bool padrão: false
- Mostre o plano de autocompletar sem gravar arquivo.
--help, -h bool padrão: false
- Ajuda para setup.
--save string padrão: vazio
- Salve um novo script no caminho informado sem alterar o perfil do shell.
--shell string padrão: auto
- Shell do autocompletar: auto, powershell, bash, zsh ou fish.

Detect a supported shell and show completion setup instructions. Use --shell to select one explicitly. Without --save, no file is written. With --save PATH, write a new script generated from the current command tree; the parent directory must exist and the destination must not exist. The command never edits shell profiles or loads the script. --dry-run shows the plan without writing a file.

Exemplo do comando

Shell

raims completion setup
  raims completion setup --shell powershell --save raims-completion.ps1 --dry-run
  raims completion setup --shell bash --save raims-completion.bash
  raims --output json completion setup --shell zsh

`raims completion zsh`

Gera o script de autocompletar para Zsh.

Shell

raims completion zsh [flags]

--help, -h bool padrão: false
- Exibe a ajuda de zsh.
--no-descriptions bool padrão: false
- Omite as descrições nas sugestões de autocompletar.

Generate the autocompletion script for the zsh shell.

If shell completion is not already enabled in your environment you will need
to enable it.  You can execute the following once:

    echo "autoload -U compinit; compinit" >> ~/.zshrc

To load completions in your current shell session:

    source <(raims completion zsh)

To load completions for every new session, execute once:

#### Linux:

    raims completion zsh > "${fpath[1]}/_raims"

#### macOS:

    raims completion zsh > $(brew --prefix)/share/zsh/site-functions/_raims

You will need to start a new shell for this setup to take effect.

`raims config`

Consulta a configuração local do CLI.

Shell

raims config [flags]

--help, -h bool padrão: false
- Exibe a ajuda de config.

Subcomandos: raims config path.

`raims config path`

Mostra o caminho do arquivo de configuração sem criá-lo.

Shell

raims config path [flags]

--help, -h bool padrão: false
- Exibe a ajuda de path.

`raims docs`

Leia a documentação pública da Raims no terminal.

Shell

raims docs [PATH] [flags]

--help, -h bool padrão: false
- Ajuda para docs.
--language string padrão: br
- Idioma da documentação: br ou en.
--offline bool padrão: false
- Leia somente o cache existente da documentação, inclusive uma cópia antiga.
--refresh bool padrão: false
- Baixe uma cópia atual da documentação pública em vez de ler o cache.
--timeout duration padrão: 1m0s
- Prazo da consulta à documentação, como 30s ou 2m.

Read a public Raims documentation page without an API key. Use a path such as cli/configuration or /br/cli/configuration. Without a path, read the CLI guide in the selected language. The public source is cached for 24 hours. --offline reads an existing cache, including an older copy, and reports its age. --refresh downloads a new copy and fails if the download is unavailable. Markdown is printed as plain text; commands and links are not executed.

Exemplo do comando

Shell

raims docs
  raims docs cli/configuration
  raims docs /en/cli --language en
  raims --output json docs cli/automation --offline
  raims docs search webhooks

Subcomandos: raims docs search.

`raims docs search`

Busque na documentação pública da Raims.

Shell

raims docs search QUERY... [flags]

--help, -h bool padrão: false
- Ajuda para search.
--limit int padrão: 10
- Quantidade máxima de resultados da busca na documentação, de 1 a 50.

Search public Raims documentation by title, path and content in the selected language. Results include the page URL and a plain text excerpt. Searches ignore case and accents. The search runs locally after reading the public source or its cache; your search terms are not sent to a search service. Use --limit to control how many results are shown.

Exemplo do comando

Shell

raims docs search webhooks
  raims docs search "chaves de API" --offline
  raims --output json docs search checkout --language en --limit 5

`raims doctor`

Verifica a configuração local, as permissões, a instalação e a política de atualização.

Shell

raims doctor [flags]

--help, -h bool padrão: false
- Exibe a ajuda de doctor.

`raims help`

Consulta a ajuda de um comando.

Shell

raims help [command] [flags]

--help, -h bool padrão: false
- Exibe a ajuda de help.

`raims licenses`

Leia os avisos de terceiros incluídos neste executável.

Shell

raims licenses [flags]

--help, -h bool padrão: false
- Ajuda para licenses.

Conecte um perfil pelo login no navegador.

Shell

raims login [flags]

Sign in through the Raims browser and authorize the CLI. Choose an environment explicitly. OAuth credentials are encrypted with a key held by the system credential store. Requires an interactive terminal; use API-key profiles in CI. Repeating login verifies and reuses an active authorization, or opens a new consent when it has expired or been revoked. A profile backed by an API key is never overwritten.

`raims logout`

Revogue uma conexão OAuth e remova seu perfil local.

Shell

raims logout [flags]

--help, -h bool padrão: false
- Ajuda para logout.

Revoke the selected OAuth connection, then remove its encrypted credentials and local profile. A failed revocation preserves the local session so you can retry. API-key profiles remain managed by 'profile remove'.

`raims mcp`

Configure um cliente de IA para o MCP da Raims.

Shell

raims mcp [flags]

--help, -h bool padrão: false
- Ajuda para mcp.

Show connection instructions and safe configuration snippets for the Raims remote MCP server. Your MCP client handles browser sign-in and consent. This group does not read an API profile, load credentials, contact the server or change an installed client's settings.

Subcomandos: raims mcp setup.

`raims mcp setup`

Veja as instruções do MCP ou salve um novo snippet de configuração.

Shell

raims mcp setup [flags]

--client string padrão: all
- Cliente MCP: all, codex, claude-code ou cursor.
--dry-run bool padrão: false
- Valide e apresente o plano de configuração sem gravar arquivo.
--help, -h bool padrão: false
- Ajuda para setup.
--save string padrão: vazio
- Salve um novo snippet de configuração no caminho informado.

Show setup instructions for Codex, Claude Code or Cursor. OAuth uses the Raims browser sign-in and consent flow. Without --save, no file is written. With --save PATH and one --client, save a new standalone snippet; the destination must not exist and its parent directory must already exist. Merge the snippet into your client settings yourself, preserving other servers. The command never runs another client or edits an existing configuration. --dry-run validates the plan without writing a file.

Exemplo do comando

Shell

raims mcp setup
  raims mcp setup --client codex
  raims mcp setup --client cursor --save raims-mcp.json --dry-run
  raims mcp setup --client claude-code
  raims --output json mcp setup --client codex

`raims open`

Abra a documentação e páginas do Dashboard da Raims.

Shell

raims open [shortcut] [flags]

--help, -h bool padrão: false
- Exibe a ajuda de open.

Exemplo do comando

Shell

raims open docs
  raims open api
  raims open webhooks
  raims --no-input --output json open docs

`raims profile`

Gerencia perfis locais sem armazenar os valores das chaves de API.

Shell

raims profile [flags]

--help, -h bool padrão: false
- Exibe a ajuda de profile.

Subcomandos: raims profile list, raims profile remove, raims profile set, raims profile show, raims profile use.

`raims profile list`

Lista os perfis configurados.

Shell

raims profile list [flags]

--help, -h bool padrão: false
- Exibe a ajuda de list.

`raims profile remove`

Remova um perfil local sem revogar sua chave de API.

Shell

raims profile remove NAME [flags]

--help, -h bool padrão: false
- Ajuda para remove.

Remove a named profile from local configuration. If it is the saved default, clear that selection without choosing another profile. The key and its environment variable remain unchanged. Repeating the command succeeds when the profile is already absent.

Exemplo do comando

Shell

raims profile remove old-project
  raims --output json profile remove old-project

`raims profile set`

Salva um perfil associado ao nome da variável de ambiente da chave de API.

Shell

raims profile set NAME --api-key-env VARIABLE [flags]

--api-key-env string obrigatório padrão: vazio
- Nome da variável de ambiente da chave de API, com letras maiúsculas, dígitos e sublinhado.
--help, -h bool padrão: false
- Exibe a ajuda de set.