promptfoo/site/docs/installation.md

title	description	keywords	sidebar_position
Install Promptfoo	Learn how to install promptfoo using npm, npx, or Homebrew. Set up promptfoo for command-line usage or as a library in your project.	[install installation npm npx homebrew setup promptfoo]	4

import CodeBlock from '@theme/CodeBlock'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Installation

Requirements

• Node.js 18 or newer
• Supported operating systems: macOS, Linux, Windows

For Command-Line Usage

Install promptfoo using npx, npm, or brew:

npm install -g promptfoo npx promptfoo@latest brew install promptfoo

For Library Usage

Install promptfoo as a library in your project:

npm install promptfoo --save

Verify Installation

To verify that promptfoo is installed correctly, run:

promptfoo --version npx promptfoo@latest --version promptfoo --version

This should display the version number of promptfoo:

0.114.7

Run Promptfoo

After installation, you can start using promptfoo by running:

promptfoo init npx promptfoo@latest init promptfoo init

This will create a promptfooconfig.yaml placeholder in your current directory.

For more detailed usage instructions, please refer to our Getting Started guide.