Raims CLI

Use raims in your terminal to query and manage public API resources, such as customers, charges, payment links, withdrawals, and webhooks. The commands also work in scripts and pipelines, with JSON output and defined exit codes.

Connect your account through your browser with OAuth or use an API key for scripts and integrations. Both modes send requests to https://api.raims.com. The API checks the company, environment, permissions, and resource conditions.

Install

Packages are provided for Windows (x64 and ARM64), Linux (x64 and ARM64), and macOS (x64 and ARM64). On Windows ARM64, use ARM64 Node.js to install and run the native CLI. Choose your preferred package manager and install the CLI globally:

npm install -g @raimshq/cli@latest

After installing the CLI, run raims version to check the version.

The yarn tab uses Yarn Classic (1.x). With Yarn 2 or later, run yarn dlx @raimshq/cli@latest version; replace version with the command you want to run. This runs the CLI on demand without a global installation.

npm selects the executable using the Node.js architecture. If needed, check the installation architecture.

Installation and updates need internet access to obtain the package. API commands need access to api.raims.com; reading guides needs access to docs.raims.com, except when explicitly reading the cache with --offline. Help, the command map, local profiles, and doctor do not require a network.

To update or remove the CLI, use the same package manager you installed it with:

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

In pipelines, fetch the current version during installation as described in CI and automation.

Package-manager installations follow their manager's update mechanism and do not enable the direct installer's updater.

Direct installation provides the native executable with updates managed by the CLI.

Discover commands

Use raims --map to see the complete command tree with a description of each command. Specify a group to narrow the result:

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

compact omits descriptions, paths lists full command paths, and json returns the structured tree. The map does not require a profile, key, or body, and it does not execute the displayed commands.

To prepare a request, add --help to the command. For commands with a JSON body, help shows fields, types, required fields, nullable fields, and accepted values. Invocation examples use --dry-run; replace placeholders and review the file before sending it. Body examples, when present, come from the public API reference.

Help rearranges its columns to fit the terminal width. Command and JSON examples keep their content so you can copy them; these lines may extend beyond the available width. In files and pipes, help keeps its original layout.

First commands

Create and update commands read the JSON body through --data-file or the simple field flags listed in --help. See CI and automation to send files, read multiple pages, and handle pending results or failures. The simulations group runs simulations allowed by the API for the credential and resource.

Read notices and licenses

Starting with version 0.1.1, raims licenses reads the third-party notices, licenses, and terms included in the running version:

raims licenses
raims licenses --output json

This is a local read that does not require a profile, key, or network access. The JSON output contains the text in text and its SHA-256 hash in sha256.

Read guides in the terminal

Use raims docs search to find guidance in the public documentation:

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

To read a guide, provide its website path. Without a path, raims docs shows the CLI guide:

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

These commands do not require a profile or key. Search uses public Raims content and supports --output json. --language br|en selects the language; Portuguese is the default. The path must match the selected language. External URLs and local file paths are not accepted.

Content is cached for 24 hours. Use --refresh to fetch the latest version or --offline to use only cached content, including old content. The result reports the source and age of the content. Without a cache, --offline returns an error. The two options cannot be combined; a failed refresh does not silently fall back to an old copy.

Open official pages

raims open lists shortcuts for the documentation, API reference, Dashboard, API keys, webhooks, and Raims status. To open the CLI documentation:

raims open docs

The destinations are fixed, and the command does not accept another URL. In CI, with --no-input, or without a terminal, it prints the address without starting a browser. Use --output json to receive target, url, and opened.

Choose your path

Profiles and credentials

A profile can use an OAuth session or an API key. With OAuth, sign-in happens in your browser and the session is protected by the operating system's secure store. For scripts, associate an environment variable with your API key; the profile file stores only the variable name.

See Configuration and profiles to connect, check access, select the environment, and sign out. For integration credentials, see API keys and Authentication.