Rawi (راوي) Documentation | Getting Started

Prerequisites to Use the Rawi CLI

To use the Rawi CLI, you need to meet a few prerequisites depending on the AI provider you want to access. Rawi supports multiple providers, each with its own requirements for credentials and setup.

System Requirements

Node.js: Version 18.0.0 or higher
Package Manager: npm, pnpm, or yarn
Operating System: Linux, macOS, or Windows

Provider Credentials

To access AI services with Rawi, you need credentials for the provider you want to use. For security, do not share your API keys or credentials.

Provider	Prerequisite Account / Credentials	Notes
OpenAI	OpenAI account, API key	Get API key from OpenAI Platform
Anthropic	Anthropic account, API key	Get API key from Anthropic Console
Google Gemini	Google account, API key	Get API key from Google AI Studio
Ollama (local)	None (runs locally)	Install Ollama and pull models
Azure OpenAI	Azure subscription, API key, resource name	See Azure OpenAI docs
Amazon Bedrock	AWS account, IAM credentials or access keys	Use IAM user or AWS credential chain
Qwen (Alibaba)	Alibaba Cloud account, API key
xAI	xAI account, API key

Security Best Practices

Do not use root or admin credentials for daily tasks.
Create provider-specific users or API keys with least privilege.
Store credentials securely (Rawi stores them encrypted in ~/.rawi/).
For AWS Bedrock, use IAM roles or the AWS credential provider chain.

Next Steps

After you have the required credentials:

Install Rawi CLI:
Terminal window
```
npm install -g rawi
```
Configure your first provider (interactive):
Terminal window
```
rawi configure
```
Or configure via command line for automation:
Terminal window
```
rawi configure --provider openai --api-key <your-key> --model gpt-4o
```
Verify installation:
Terminal window
```
rawi --version
rawi info
```
Start using Rawi:
Terminal window
```
rawi ask "What is TypeScript?"
```