Skip to main content

Installation

Install promptfoo using npm, npx, or Homebrew (Mac, Linux):

npm install -g promptfoo
note

npm and npx require Node.js 20.20+ or 22.22+.

To use promptfoo as a library in your project, run npm install promptfoo --save.

Verify Installation​

To verify that promptfoo is installed correctly, run:

promptfoo --version

This should display the current version number of promptfoo.

Run Promptfoo​

After installation, you can start using promptfoo by running:

promptfoo init

This will guide you through the process of creating a promptfooconfig.yaml file.

For a guide on running your first evaluation, please refer to our Getting Started guide.

Uninstall Promptfoo​

Remove the package​

If you installed promptfoo with more than one method (for example, both npm and Homebrew), repeat the relevant steps for each.

npm uninstall -g promptfoo

If you installed promptfoo as a project dependency, remove it from your project:

npm uninstall promptfoo

Verify removal​

After uninstalling, confirm that promptfoo is no longer available globally:

which -a promptfoo

If this still returns a path, you have another global installation that needs to be removed. Note that project-local installs (node_modules/.bin/promptfoo) are not detected by these commands — remove those with the project dependency step above.

Remove configuration and data (optional)​

Promptfoo stores configuration, eval history, and cached results in ~/.promptfoo (%USERPROFILE%\.promptfoo on Windows). Uninstalling the package does not remove this directory.

warning

This permanently deletes your eval history, database, and cached results.

rm -rf ~/.promptfoo

If you set custom paths via environment variables, remove those directories as well:

  • PROMPTFOO_CONFIG_DIR — configuration and database
  • PROMPTFOO_CACHE_PATH — cached results
  • PROMPTFOO_LOG_DIR — log files

See Also​

Last updated on by mldangelo-oai