getting-started (Getting Started Example)

You can run this example with:

bash

npx promptfoo@latest init --example getting-started
cd getting-started

This is a simple example that demonstrates the basic functionality of promptfoo. It tests two different translation prompts across multiple language models.

Setup

Set your OpenAI API key:

bash

export OPENAI_API_KEY=your-key-here

Tip: you can also put this key in a .env file. Be sure not to commit it to git.

Run the evaluation:

bash

promptfoo eval

What's happening?

This example:

Tests two different ways to phrase a translation prompt
Compares outputs between GPT-5.2 and GPT-5 Mini
Uses two test cases with different languages and inputs

The configuration in promptfooconfig.yaml shows:

How to define prompts with variables using {{variable_name}}
How to specify multiple providers (models)
How to set up test cases with different variable values

This is the same example shown in the Getting Started guide at https://promptfoo.dev/docs/getting-started