Getting Started
Getting Started with Beryl
This guide walks you through everything you need to go from a URL to a running, scheduled test project. There is nothing to install — Beryl runs entirely in our infrastructure — so the whole thing takes only a few minutes.
Step 1 - Enter your URL
Drop the URL of the app you want to test into Beryl. There is no SDK to add to your repo and no CLI to run. Beryl immediately begins crawling your app, and you can watch the crawl happen live.
For most teams the right URL is your production app, since that is what your users actually see. You can re-crawl the same site any time.
Step 2 - Let Beryl generate your tests
As Beryl crawls, it discovers the pages and flows in your app and turns each one into a readable test written in plain language. There are no selectors, no XPath, and no code to maintain — anyone on the team can read what each test does.
The generated tests appear in place as the crawl completes, so you can see your project take shape without writing a thing.
Step 3 - Run your project and read the report
Run the generated project against your app. Beryl executes each test the way a real user would — clicking buttons, filling forms, and running flows end to end — then produces a detailed report showing which tests passed, which failed, and how long each took. No digging through CI logs required.
Step 4 - Cover login-gated pages
Many of the most important flows live behind a login. Beryl can sign in to your app and crawl and test the pages your users see once authenticated. Where possible, use a dedicated test or staging account for this. Beryl handles credentials securely — see how Beryl protects your data for details.
Step 5 - Put it on a schedule
Production drifts after you deploy. Beryl re-runs your whole project against your app on a schedule and diffs each run against the previous one, so regressions surface before they reach your users. Over time you build up a pass-rate history that shows whether your app is staying stable.
Next steps
If you run into any issues during setup, contact [email protected]. We respond to all requests within one business day.