Onboarding
Walk through the TestRelic onboarding wizard to set up your profile, select your test frameworks, and connect your first repository.
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.
Two ways to arrive at onboarding
How you land in onboarding — and what organization you land in — depends on whether you signed up yourself or were invited:
- Self-signup. If you sign up on your own (no invitation), TestRelic automatically creates a new organization for you and makes you its admin — there is no waiting on anyone else and no separate "create an organization" step. The organization is named from your company name if you provided one during signup, or defaults to "Your Name's Organization" otherwise. As admin, you have full access to Settings, API keys, MCP tokens, billing, and user management from the moment you verify your email, even before you complete the onboarding wizard below.
- Invited member. If someone invites you to their organization, accepting the invite joins you to their organization with the role they assigned — no new organization is created for you. See User Management for how admins invite teammates.
Self-signup admins still see the onboarding wizard — onboardingDone starts false for a fresh organization either way. The difference is scope: a self-signup founder already has admin access to every org-scoped page while working through it, since they're the sole member of a brand-new organization.
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 — @testrelic/playwright-analytics reporter and cloud integration |
| Appium | Full support — @testrelic/appium-analytics reporter for Android and iOS |
| Cypress | Coming soon |
| Selenium | Coming soon |
Selecting Playwright or Appium during onboarding displays framework-specific setup code snippets in your repository detail page. Cypress and Selenium are listed for future use and 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-analyticsor@testrelic/appium-analyticsreporter. - Navigate to the platform to add your first repository.
Save your API key
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.
Authentication
Sign in through TestRelic's hosted login pages with email/password or GitHub, set up two-factor authentication or a passkey, enforce 2FA org-wide, and authorize the CLI from your browser.
Dashboard & Test Runs
Explore the organization-wide test runs dashboard, apply filters, navigate CI environments, and drill into individual runs.