From 56b83691bddbf971d90f4aa0dae87eaf2232b0c3 Mon Sep 17 00:00:00 2001 From: Luc Gagan Date: Tue, 14 Nov 2023 08:58:43 -0600 Subject: [PATCH] docs: document how to debug functions --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index d5b19c3..9b91767 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,14 @@ At minimum, the `auto` function requires a _plain text prompt_ and an _argument_ auto("", { page, test }); ``` +### Debug + +You may pass a `debug` attribute as the third parameter to the `auto` function. This will print the prompt and the commands executed by OpenAI. + +```ts +await auto("get the header text", { page, test }, { debug: true }); +``` + ## Supported Browsers Every browser that Playwright supports.