Command reference | Raims Documentation

--color string default: auto
- Terminal colors: auto, on or off (JSON and completion stay uncolored)
--debug bool default: false
- Write diagnostic JSON events to stderr without credentials or command arguments
--environment string default: empty
- Select sandbox or production for OAuth or an OAuth dry run; API keys determine their own environment
--help, -h bool default: false
- help for raims
--map string default: empty
- List the command tree without executing a command: tree, compact, paths or json
--no-input bool default: false
- Disable interactive prompts (also enforced in CI and without a terminal)
--output, -o string default: text
- Output format: text or json
--profile string default: empty
- Use a profile for this command (overrides RAIMS_PROFILE and the saved default)
--version, -v bool default: false
- version for raims

Command example

Shell

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

Subcommands: 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`

Check API authentication for the selected profile

Shell

raims auth [flags]

--help, -h bool default: false
- help for auth

Subcommands: raims auth check, raims auth status.

`raims auth check`

Validate the selected credential with a read-only account request

Shell

raims auth check [flags]

--help, -h bool default: false
- help for check
--show-headers bool default: false
- Show public response headers without credentials or cookies
--timeout duration default: 1m0s
- Total request timeout, including retries and waits

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`

Inspect local authentication metadata without reading credentials or using the network

Shell

raims auth status [flags]

--help, -h bool default: false
- help for status

`raims completion`

Generate the autocompletion script for the specified shell

Shell

raims completion [flags]

--help, -h bool default: false
- help for completion

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

`raims completion bash`

Generate the autocompletion script for bash

Shell

raims completion bash

--help, -h bool default: false
- help for bash
--no-descriptions bool default: false
- disable completion descriptions

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`

Generate the autocompletion script for fish

Shell

raims completion fish [flags]

--help, -h bool default: false
- help for fish
--no-descriptions bool default: false
- disable completion descriptions

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`

Generate the autocompletion script for powershell

Shell

raims completion powershell [flags]

--help, -h bool default: false
- help for powershell
--no-descriptions bool default: false
- disable completion descriptions

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`

Plan shell completion setup or save a new completion script

Shell

raims completion setup [flags]

--dry-run bool default: false
- Show the completion setup plan without writing a file
--help, -h bool default: false
- help for setup
--save string default: empty
- Save a new completion script to PATH without changing shell profiles
--shell string default: auto
- Shell for completion: auto, powershell, bash, zsh or 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.

Command example

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`

Generate the autocompletion script for zsh

Shell

raims completion zsh [flags]

--help, -h bool default: false
- help for zsh
--no-descriptions bool default: false
- disable completion descriptions

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`

Inspect local CLI configuration

Shell

raims config [flags]

--help, -h bool default: false
- help for config

Subcommands: raims config path.

`raims config path`

Show the configuration file path without creating it

Shell

raims config path [flags]

--help, -h bool default: false
- help for path

`raims docs`

Read public Raims documentation in the terminal

Shell

raims docs [PATH] [flags]

--help, -h bool default: false
- help for docs
--language string default: br
- Documentation language: br or en
--offline bool default: false
- Read only an existing documentation cache, including an older copy
--refresh bool default: false
- Download fresh public documentation instead of reading the cache
--timeout duration default: 1m0s
- Documentation request timeout (for example 30s or 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.

Command example

Shell

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

Subcommands: raims docs search.

`raims docs search`

Search public Raims documentation

Shell

raims docs search QUERY... [flags]

--help, -h bool default: false
- help for search
--limit int default: 10
- Maximum documentation search results (1-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.

Command example

Shell

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

`raims doctor`

Check local configuration, permissions, installation and update policy

Shell

raims doctor [flags]

--help, -h bool default: false
- help for doctor

`raims help`

Help about any command

Shell

raims help [command] [flags]

--help, -h bool default: false
- help for help

`raims licenses`

Read the third-party notices included in this executable

Shell

raims licenses [flags]

--help, -h bool default: false
- help for licenses

Connect a profile through browser sign-in

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`

Revoke an OAuth connection and remove its local profile

Shell

raims logout [flags]

--help, -h bool default: false
- help for 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 an AI client for the Raims MCP server

Shell

raims mcp [flags]

--help, -h bool default: false
- help for 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.

Subcommands: raims mcp setup.

`raims mcp setup`

Show MCP setup instructions or save a new configuration snippet

Shell

raims mcp setup [flags]

--client string default: all
- MCP client: all, codex, claude-code or cursor
--dry-run bool default: false
- Validate and show the setup plan without writing a file
--help, -h bool default: false
- help for setup
--save string default: empty
- Save a new standalone configuration snippet to PATH

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.

Command example

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`

Open Raims documentation and Dashboard pages

Shell

raims open [shortcut] [flags]

--help, -h bool default: false
- help for open

Command example

Shell

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

`raims profile`

Manage local profiles without storing API keys

Shell

raims profile [flags]

--help, -h bool default: false
- help for profile

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

`raims profile list`

List configured profiles

Shell

raims profile list [flags]

--help, -h bool default: false
- help for list

`raims profile remove`

Remove a local profile without revoking its API key

Shell

raims profile remove NAME [flags]

--help, -h bool default: false
- help for 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.

Command example

Shell

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

`raims profile set`

Save a profile using an API key environment variable name

Shell

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

--api-key-env string required default: empty
- API key environment variable name (uppercase letters, digits and underscores)
--help, -h bool default: false
- help for set