Docs
Checking Raims account

Direct installation

Install the native Raims CLI executable and control updates for your installation.

Direct installation uses the native Raims CLI executable. This channel does not require Node.js or npm. The installer accesses the distribution channel over the internet, verifies the files, and writes the installation to a user directory without requesting an API key.

To install through npm in automation, follow CI and automation, which uses @latest.

Choose the installer

Choose the operating system and architecture of the machine that will run the CLI:

0.1.2 identifies the installer version. When it checks the channel, it selects the latest stable patch in the 0.1 line. The filename does not pin the CLI version that will be installed. Review the version shown in the plan.

On Windows ARM64, choose the ARM64 installer to run the CLI natively. This direct installation does not require Node.js. To check the architecture of an existing installation, see Diagnostics.

On Windows, you can inspect the file's digital signature with Get-AuthenticodeSignature. If the result is not Valid, do not run the file; check the official download.

Review the plan and install

Without -apply, the installer checks the channel and shows the version and destination without applying the installation. Run it again with -apply after reviewing the plan. The examples below download the installer and use the default destination.

PowerShell
Invoke-WebRequest -Uri 'https://static.raims.com/cli/direct/installers/0.1.2/raims-install-0.1.2-windows-amd64.exe' -OutFile '.\raims-install-0.1.2-windows-amd64.exe'
.\raims-install-0.1.2-windows-amd64.exe
.\raims-install-0.1.2-windows-amd64.exe -apply

-directory PATH selects another absolute destination within the user's space. The directory must be writable and cannot be accessed through links or junctions. The installer does not elevate permissions or replace unknown files or an installation of another version. An exact retry reuses the installation and preserves additional files.

Use the installed executable

The default destinations are:

SystemExecutable
Windows%LOCALAPPDATA%\Raims\CLI\raims.exe
Linux and macOS~/.local/share/raims/cli/raims

You can use the full path without changing PATH:

PowerShell
& "$env:LOCALAPPDATA\Raims\CLI\raims.exe" version
& "$env:LOCALAPPDATA\Raims\CLI\raims.exe" update status

If you chose another destination, use the executable in that directory. Installation does not create a profile or store an API key. To make requests, follow Configuration and profiles.

Create a command in PATH

-link-user-path is an explicit choice and requires -apply and -path-directory PATH. That directory must exist within the user's space and already be in the session's PATH. The installer does not edit shell profiles, the registry, or the PATH value.

In the example below, use ~/.local/bin only if the directory already exists and is in PATH:

Shell
./raims-install -apply -link-user-path -path-directory "$HOME/.local/bin"
raims version

On Windows, the same options accept a user directory already in PATH. WindowsApps is not accepted as a destination for this integration.

Resolve conflicts with other installations, shell aliases, or functions before creating the entry. The installer rejects an earlier command in PATH or a conflicting entry in the selected directory. If integration fails, the verified installation is preserved; use the executable's full path.

Control updates

In a direct installation, the CLI can silently check for updates while it is used. A downloaded version remains pending and can be activated on the next eligible invocation without interrupting a command already running. If the check or verification fails, the installed version is preserved.

raims update status shows the policy and local versions without fetching an update. RAIMS_CLI_NO_UPDATE=1 disables checks and pending activation; it does not revert a version already active.

RAIMS_CLI_PIN_VERSION requires a version already installed or retained by the CLI. The pin does not download a version. CI environments disable automatic checks and activation. Use @latest in npm installation examples, including CI. See how to derive the direct installation's pin in CI and automation.

Keep versions and backups

Keep the cached versions, original installation, and CLI backups. These files allow you to select retained versions and recover an installation. This release does not automatically clean up that history.

Do not delete versions while commands are running. The CLI does not automatically repeat a command that has already started and then failed.

Read notices and licenses

raims licenses reads the texts included in the running version without a profile, key, or network access. Its JSON output contains text and sha256. See the examples in Notices and licenses.