Rawi (راوي) Documentation | Getting Started Install

Installing or Updating Rawi CLI

The Rawi Command Line Interface (Rawi CLI) is an open source tool that enables you to interact with AI providers and manage your Rawi configuration directly from your terminal. With minimal setup, you can start running commands to ask questions, manage profiles, and view history—all from your command-line shell.

Supported Platforms

• Linux shells – Use bash, zsh, or other common shells.
• macOS – Use Terminal or iTerm.
• Windows – Use Command Prompt or PowerShell.

Prerequisites

• Node.js 18+ is required. We recommend using nvm to manage Node.js versions.
• A supported package manager: npm or pnpm.

Install or Update Rawi CLI

Installation

pnpm

pnpm add -g rawi

npm

npm install -g rawi

yarn

yarn global add rawi

Updating

To update Rawi CLI to the latest version, use the same command you used for installation. The package manager will handle the update automatically.

pnpm

pnpm update -g rawi

npm

npm update -g rawi

yarn

yarn global upgrade rawi

Verify Installation

Check your installed version:

Linux

rawi --version

rawi/0.0.0-beta.12 linux-x64 node-18.20.2

macOS

rawi --version

rawi/0.0.0-beta.12 darwin-x64 node-18.20.2

Windows

rawi --version

rawi/0.0.0-beta.12 win32-x64 node-18.20.2

If the rawi command is not found, ensure your package manager’s global bin directory is in your PATH. Use the appropriate instructions for your OS and package manager:

Linux/macOS - Global Bin

pnpm

# Find the global pnpm bin directory
pnpm bin -g
# Add it to your PATH (if not already present)
export PATH="$PATH:$(pnpm bin -g)"
# Optionally, add the above line to your ~/.bashrc, ~/.zshrc, or shell profile

npm

# Find the global npm bin directory
npm config get prefix
# Add it to your PATH (if not already present)
export PATH="$PATH:$(npm config get prefix)/bin"
# Optionally, add the above line to your ~/.bashrc, ~/.zshrc, or shell profile

yarn

# Find the global yarn bin directory
yarn global bin
# Add it to your PATH (if not already present)
export PATH="$PATH:$(yarn global bin)"
# Optionally, add the above line to your ~/.bashrc, ~/.zshrc, or shell profile

Windows - Global Bin

pnpm

# Find the global pnpm bin directory
pnpm bin -g
# Add it to your PATH (in System Properties > Environment Variables)
# Example (in PowerShell):
$env:Path += ";$(pnpm bin -g)"

npm

# Find the global npm bin directory
npm config get prefix
# Add it to your PATH (in System Properties > Environment Variables)
# Example (in PowerShell):
$env:Path += ";$(npm config get prefix)\bin"

yarn

# Find the global yarn bin directory
yarn global bin
# Add it to your PATH (in System Properties > Environment Variables)
# Example (in PowerShell):
$env:Path += ";$(yarn global bin)"

Uninstall Rawi CLI

pnpm

pnpm remove -g rawi

npm

npm uninstall -g rawi

yarn

yarn global remove rawi

Troubleshooting

If you encounter issues, see the Troubleshooting Guide for solutions to common installation and configuration problems.

---

Next steps:
After installing Rawi CLI, run the following to configure your first provider:

rawi configure