You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-10Lines changed: 9 additions & 10 deletions
Original file line number
Diff line number
Diff line change
@@ -28,14 +28,14 @@
28
28
-[observe()](#observe)
29
29
-[page and context](#page-and-context)
30
30
-[log()](#log)
31
+
-[Model Support](#model-support)
31
32
-[How It Works](#how-it-works)
32
33
-[Roadmap](#roadmap)
33
34
-[Contributing](#contributing)
34
35
-[Acknowledgements](#acknowledgements)
35
36
-[License](#license)
36
37
37
-
> [!NOTE]
38
-
> `Stagehand` is currently available as an early release, and we're actively seeking feedback from the community. Please join our [Slack community](https://join.slack.com/t/stagehand-dev/shared_invite/zt-2tdncfgkk-fF8y5U0uJzR2y2_M9c9OJA) to stay updated on the latest developments and provide feedback.
38
+
> [!NOTE] > `Stagehand` is currently available as an early release, and we're actively seeking feedback from the community. Please join our [Slack community](https://join.slack.com/t/stagehand-dev/shared_invite/zt-2tdncfgkk-fF8y5U0uJzR2y2_M9c9OJA) to stay updated on the latest developments and provide feedback.
39
39
40
40
## Intro
41
41
@@ -213,8 +213,7 @@ This constructor is used to create an instance of Stagehand.
213
213
214
214
#### `observe()`
215
215
216
-
> [!NOTE]
217
-
> `observe()` currently only evaluates the first chunk in the page.
216
+
> [!NOTE] > `observe()` currently only evaluates the first chunk in the page.
218
217
219
218
`observe()` is used to get a list of actions that can be taken on the current page. It's useful for adding context to your planning step, or if you unsure of what page you're on.
220
219
@@ -253,7 +252,7 @@ Make sure the log level is above the verbose level you set when initializing the
253
252
stagehand.log("Hello, world!");
254
253
```
255
254
256
-
###Model Support
255
+
## Model Support
257
256
258
257
Stagehand leverages a generic LLM client architecture to support various language models from different providers. This design allows for flexibility, enabling the integration of new models with minimal changes to the core system. Different models work better for different tasks, so you can choose the model that best suits your needs.
Ensure you have the `.env` file as documented above in the Getting Started section.
352
351
353
-
Then, run the example script `pnpm example`.
352
+
Then, run the example script `npm run example`.
354
353
355
354
### Development tips
356
355
@@ -370,19 +369,19 @@ You'll need a Braintrust API key to run evals
370
369
BRAINTRUST_API_KEY=""
371
370
```
372
371
373
-
After that, you can run the eval using `pnpm evals`
372
+
After that, you can run the eval using `npm run evals`
374
373
375
374
### Adding new evals
376
375
377
376
Running all evals can take some time. We have a convenience script `example.ts` where you can develop your new single eval before adding it to the set of all evals.
378
377
379
-
You can run `pnpm example` to execute and iterate on the eval you are currently developing.
378
+
You can run `npm run example` to execute and iterate on the eval you are currently developing.
380
379
381
380
### Building the SDK
382
381
383
382
Stagehand uses [tsup](https://github.com/egoist/tsup) to build the SDK and vanilla `esbuild` to build scripts that run in the DOM.
384
383
385
-
1. run `pnpm build`
384
+
1. run `npm run build`
386
385
2. run `npm pack` to get a tarball for distribution
0 commit comments