From 3e598424475ada8c6abd271f74783de3df36507d Mon Sep 17 00:00:00 2001 From: Ian Webster Date: Thu, 26 Oct 2023 19:10:21 -0700 Subject: [PATCH] Add local build instructions. Closes #250 --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 580aa78ec36..aab2694034c 100644 --- a/README.md +++ b/README.md @@ -292,6 +292,17 @@ We support OpenAI's API as well as a number of open-source models. It's also to ## Development +Here's how to build and run locally: + +```sh +git clone https://github.com/promptfoo/promptfoo.git +cd promptfoo + +npm i +cd path/to/experiment-with-promptfoo # contains your promptfooconfig.yaml +npx path/to/promptfoo-source eval +``` + Contributions are welcome! Please feel free to submit a pull request or open an issue. `promptfoo` includes several npm scripts to make development easier and more efficient. To use these scripts, run `npm run ` in the project directory.