Onboarding
After signing up and verifying your email, TestRelic guides you through a multi-step onboarding wizard. This wizard is required before you can access the main platform — it ensures your organization and reporting configuration are ready from day one.
Onboarding steps
Step 1 — Profile setup
Fill in your display name and organization details. This information is used across the platform and in exported reports.
Your email address is pre-filled from signup and cannot be changed during onboarding. You can update it later in Profile Settings.
Step 2 — Select your frameworks
Choose the test frameworks your team uses. This step helps TestRelic configure the right reporter and integration defaults for your organization.
| Framework | Status |
|---|---|
| Playwright | Full support — live reporter and cloud integration |
| Cypress | Coming soon |
| Selenium | Coming soon |
| Appium | Coming soon |
Selecting Playwright during onboarding displays framework-specific setup code snippets in your repository detail page. Other frameworks are listed for future use but do not yet have active reporters.
Step 3 — Complete
The wizard generates an initial API key for your organization and displays a summary of your setup. From this screen you can:
- Copy your API key to configure the
@testrelic/playwright-analyticsreporter. - Navigate to the platform to add your first repository.
Copy your API key at this step — it is the same key you will place in your reporter configuration. You can always generate additional keys in API Keys.
After onboarding
Once you complete all three steps, the OnboardingGuard is satisfied and you are redirected to the main platform dashboard. From there you can:
- Add a repository and connect it to the reporter.
- Run your first Playwright test suite and see results appear in the Test Runs dashboard.
- Explore the AI assistant for guided help.
Skipping or revisiting onboarding
Onboarding is a one-time flow. If you navigate away before completing all steps, the platform redirects you back to the wizard until it is marked complete. You cannot skip the wizard.
Profile and framework preferences set during onboarding can be updated later in Settings.