|
| 1 | +<div id="toc" align="center" style="margin-bottom: 0;"> |
| 2 | + <ul style="list-style: none; margin: 0; padding: 0;"> |
| 3 | + <a href="https://stagehand.dev"> |
| 4 | + <picture> |
| 5 | + <source media="(prefers-color-scheme: dark)" srcset="media/dark_logo.png" /> |
| 6 | + <img alt="Stagehand" src="media/light_logo.png" width="200" style="margin-right: 30px;" /> |
| 7 | + </picture> |
| 8 | + </a> |
| 9 | + </ul> |
| 10 | +</div> |
| 11 | +<p align="center"> |
| 12 | + <strong>The AI Browser Automation Framework</strong><br> |
| 13 | + <a href="https://docs.stagehand.dev">Read the Docs</a> |
| 14 | +</p> |
| 15 | + |
| 16 | +<p align="center"> |
| 17 | + <a href="https://github.com/browserbase/stagehand/tree/main?tab=MIT-1-ov-file#MIT-1-ov-file"> |
| 18 | + <picture> |
| 19 | + <source media="(prefers-color-scheme: dark)" srcset="media/dark_license.svg" /> |
| 20 | + <img alt="MIT License" src="media/light_license.svg" /> |
| 21 | + </picture> |
| 22 | + </a> |
| 23 | + <a href="https://join.slack.com/t/stagehand-dev/shared_invite/zt-38khc8iv5-T2acb50_0OILUaX7lxeBOg"> |
| 24 | + <picture> |
| 25 | + <source media="(prefers-color-scheme: dark)" srcset="media/dark_slack.svg" /> |
| 26 | + <img alt="Slack Community" src="media/light_slack.svg" /> |
| 27 | + </picture> |
| 28 | + </a> |
| 29 | +</p> |
| 30 | + |
| 31 | +<p align="center"> |
| 32 | + <a href="https://trendshift.io/repositories/12122" target="_blank"><img src="https://trendshift.io/api/badge/repositories/12122" alt="browserbase%2Fstagehand | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a> |
| 33 | +</p> |
| 34 | + |
| 35 | +<p align="center"> |
| 36 | +If you're looking for the Python implementation, you can find it |
| 37 | +<a href="https://github.com/browserbase/stagehand-python"> here</a> |
| 38 | +</p> |
| 39 | + |
| 40 | +<div align="center" style="display: flex; align-items: center; justify-content: center; gap: 4px; margin-bottom: 0;"> |
| 41 | + <b>Vibe code</b> |
| 42 | + <span style="font-size: 1.05em;"> Stagehand with </span> |
| 43 | + <a href="https://director.ai" style="display: flex; align-items: center;"> |
| 44 | + <span>Director</span> |
| 45 | + </a> |
| 46 | + <span> </span> |
| 47 | + <picture> |
| 48 | + <img alt="Director" src="media/director_icon.svg" width="25" /> |
| 49 | + </picture> |
| 50 | +</div> |
| 51 | + |
| 52 | +## What is Stagehand? |
| 53 | + |
| 54 | +Stagehand is a browser automation framework used to control web browsers with natural language and code. By combining the power of AI with the precision of code, Stagehand makes web automation flexible, maintainable, and actually reliable. |
| 55 | + |
| 56 | +## Why Stagehand? |
| 57 | + |
| 58 | +Most existing browser automation tools either require you to write low-level code in a framework like Selenium, Playwright, or Puppeteer, or use high-level agents that can be unpredictable in production. By letting developers choose what to write in code vs. natural language (and bridging the gap between the two) Stagehand is the natural choice for browser automations in production. |
| 59 | + |
| 60 | +1. **Choose when to write code vs. natural language**: use AI when you want to navigate unfamiliar pages, and use code when you know exactly what you want to do. |
| 61 | + |
| 62 | +2. **Go from AI-driven to repeatable workflows**: Stagehand lets you preview AI actions before running them, and also helps you easily cache repeatable actions to save time and tokens. |
| 63 | + |
| 64 | +3. **Write once, run forever**: Stagehand's auto-caching combined with self-healing remembers previous actions, runs without LLM inference, and knows when to involve AI whenever the website changes and your automation breaks. |
| 65 | + |
| 66 | +## Getting Started |
| 67 | + |
| 68 | +Start with Stagehand with one line of code, or check out our [Quickstart Guide](https://docs.stagehand.dev/get_started/quickstart) for more information: |
| 69 | + |
| 70 | +```bash |
| 71 | +npx create-browser-app |
| 72 | +``` |
| 73 | + |
| 74 | +## Example |
| 75 | + |
| 76 | +Here's how to build a sample browser automation with Stagehand: |
| 77 | + |
| 78 | +```typescript |
| 79 | +// Stagehand's CDP engine provides an optimized, low level interface to the browser built for automation |
| 80 | +const page = stagehand.context.pages()[0]; |
| 81 | +await page.goto("https://github.com/browserbase"); |
| 82 | + |
| 83 | +// Use act() to execute individual actions |
| 84 | +await stagehand.act("click on the stagehand repo"); |
| 85 | + |
| 86 | +// Use agent() for multi-step tasks |
| 87 | +const agent = stagehand.agent(); |
| 88 | +await agent.execute("Get to the latest PR"); |
| 89 | + |
| 90 | +// Use extract() to get structured data from the page |
| 91 | +const { author, title } = await stagehand.extract( |
| 92 | + "extract the author and title of the PR", |
| 93 | + z.object({ |
| 94 | + author: z.string().describe("The username of the PR author"), |
| 95 | + title: z.string().describe("The title of the PR"), |
| 96 | + }), |
| 97 | +); |
| 98 | +``` |
| 99 | + |
| 100 | +## Documentation |
| 101 | + |
| 102 | +Visit [docs.stagehand.dev](https://docs.stagehand.dev) to view the full documentation. |
| 103 | + |
| 104 | + |
| 105 | +### Build and Run from Source |
| 106 | + |
| 107 | +```bash |
| 108 | +git clone https://github.com/browserbase/stagehand.git |
| 109 | +cd stagehand |
| 110 | +pnpm install |
| 111 | +pnpm run build |
| 112 | +pnpm run example # run the blank script at ./examples/example.ts |
| 113 | +``` |
| 114 | + |
| 115 | +Stagehand is best when you have an API key for an LLM provider and Browserbase credentials. To add these to your project, run: |
| 116 | + |
| 117 | +```bash |
| 118 | +cp .env.example .env |
| 119 | +nano .env # Edit the .env file to add API keys |
| 120 | +``` |
| 121 | + |
| 122 | +## Contributing |
| 123 | + |
| 124 | +> [!NOTE] |
| 125 | +> We highly value contributions to Stagehand! For questions or support, please join our [Slack community](https://join.slack.com/t/stagehand-dev/shared_invite/zt-38khc8iv5-T2acb50_0OILUaX7lxeBOg). |
| 126 | +
|
| 127 | +At a high level, we're focused on improving reliability, extensibility, speed, and cost in that order of priority. If you're interested in contributing, **bug fixes and small improvements are the best way to get started**. For more involved features, we strongly recommend reaching out to [Miguel Gonzalez](https://x.com/miguel_gonzf) or [Paul Klein](https://x.com/pk_iv) in our [Slack community](https://join.slack.com/t/stagehand-dev/shared_invite/zt-38khc8iv5-T2acb50_0OILUaX7lxeBOg) before starting to ensure that your contribution aligns with our goals. |
| 128 | + |
| 129 | +<!-- For more information, please see our [Contributing Guide](https://docs.stagehand.dev/examples/contributing). --> |
| 130 | + |
| 131 | +## Acknowledgements |
| 132 | + |
| 133 | +We'd like to thank the following people for their major contributions to Stagehand: |
| 134 | +- [Paul Klein](https://github.com/pkiv) |
| 135 | +- [Sean McGuire](https://github.com/seanmcguire12) |
| 136 | +- [Miguel Gonzalez](https://github.com/miguelg719) |
| 137 | +- [Sameel Arif](https://github.com/sameelarif) |
| 138 | +- [Thomas Katwan](https://github.com/tkattkat) |
| 139 | +- [Filip Michalsky](https://github.com/filip-michalsky) |
| 140 | +- [Anirudh Kamath](https://github.com/kamath) |
| 141 | +- [Jeremy Press](https://x.com/jeremypress) |
| 142 | +- [Navid Pour](https://github.com/navidpour) |
| 143 | + |
| 144 | +## License |
| 145 | + |
| 146 | +Licensed under the MIT License. |
| 147 | + |
| 148 | +Copyright 2025 Browserbase, Inc. |
0 commit comments