Skip to content

Ragas CLI

The Ragas Command Line Interface (CLI) provides tools for quickly setting up evaluation projects from the terminal. Each project runs its evaluation as a plain Python script (uv run python evals.py).

Installation

The CLI is included with the ragas package:

pip install ragas-ng

Or use uvx to run without installation:

uvx --from ragas-ng ragas --help

Available Commands

ragas quickstart

Create a complete evaluation project from a template. This is the fastest way to get started with Ragas.

ragas quickstart [TEMPLATE] [OPTIONS]

Arguments:

  • TEMPLATE: Template name (optional). Leave empty to see available templates.

Options:

  • -o, --output-dir: Directory to create the project in (default: current directory)

Examples:

# List available templates
ragas quickstart

# Create a RAG evaluation project
ragas quickstart rag_eval

# Create project in a specific directory
ragas quickstart rag_eval --output-dir ./my-project

ragas hello-world

Create a simple hello world example to verify your installation.

ragas hello-world [DIRECTORY]

Arguments:

  • DIRECTORY: Directory to create the example in (default: current directory)

The command writes a hello_world/ folder with a small dataset (hello_world/datasets/test_data.csv) and hello_world/evals.py, an @experiment script. Run it directly:

python hello_world/evals.py

Results are saved under hello_world/experiments/.

Quickstart Templates

RAG & Retrieval

Agent Evaluation

Specialized Use Cases

LLM Testing

Quick Start

Get running in 60 seconds:

# Create project
uvx --from ragas-ng ragas quickstart rag_eval
cd rag_eval

# Install dependencies
uv sync

# Set API key
export OPENAI_API_KEY="your-key"

# Run evaluation
uv run python evals.py

Next Steps