Skip to main content
The Rippletide CLI lets you evaluate your agent responses from the terminal with an interactive UI, real-time progress, and automatic hallucination detection.

​
Installation

npm install -g rippletide
Or run directly without installing: 
npx rippletide

​
Quick Start

rippletide
The CLI will interactively prompt you for:
  1. Your agent’s endpoint URL
  2. Knowledge source for test questions
  3. Run evaluation and display results

​
Knowledge Sources

​
1. Local Files (default)

Create a qanda.json file in your current directory: 
[
  {
    "question": "What is your primary function?",
    "answer": "I help users with various tasks through conversation."
  }
]
Then run: 
rippletide eval -a http://localhost:8000

​
2. Pinecone Database

rippletide eval -a http://localhost:8000 -k pinecone \
  -pu https://your-index.pinecone.io \
  -pk pcsk_xxxxx

​
3. PostgreSQL Database

rippletide eval -a http://localhost:8000 -k postgresql \
  -pg "postgresql://user:password@host:port/database"

​
Templates

Use pre-configured evaluation scenarios with the -t flag: 
rippletide eval -t banking_analyst
rippletide eval -t customer_service
rippletide eval -t blog_to_linkedin
Templates include both the endpoint configuration and Q&A pairs, so you can test instantly without any setup.

​
Command Line Options

​
Basic Options

OptionDescriptionExample
-t, --template <name>Use a pre-configured templaterippletide eval -t banking_analyst
-a, --agent <url>Agent endpoint URLrippletide eval -a localhost:8000
-k, --knowledge <source>Knowledge source: files, pinecone, or postgresqlrippletide eval -k pinecone
--debugShow detailed error informationrippletide eval --debug
-h, --helpShow help messagerippletide --help

​
Custom Endpoint Options

For agents that don’t use the default request/response format, you can customize headers, the request body, and the response field: 
rippletide eval -a http://localhost:8000 \
  -H "Authorization: Bearer token123, X-API-Key: mykey" \
  -B '{"prompt": "{question}"}' \
  -rf "data.response"
OptionDescription
-H, --headers <headers>Custom headers, comma-separated (e.g. "Authorization: Bearer token, X-Key: value")
-B, --body <template>Custom request body template. Use {question} as placeholder for the test question
-rf, --response-field <path>Path to the answer in the JSON response, using dot notation (e.g. data.response)

​
Agent Endpoint Requirements

Your endpoint must accept POST requests and return responses in one of these formats: 
// Direct string
"Your answer here"

// Or JSON with any of these fields
{
  "answer": "...",
  "response": "...",
  "message": "...",
  "text": "..."
}
If your endpoint uses a different format, use the -B and -rf flags above.

​
Results

After evaluation, you’ll receive:
  • Summary: Total tests, passed/failed count, duration
  • Dashboard URL: Link to view detailed results and hallucination analysis at trust.rippletide.com

​
Troubleshooting

Permission errors during installation: 
sudo npm install -g rippletide
Test agent connectivity: 
curl -X POST http://localhost:8000 \
  -H "Content-Type: application/json" \
  -d '{"message": "test"}'
Debug mode for detailed errors: 
rippletide eval --debug

​
Support