Getting Started

Setup wizard

Walk through the 3-step setup wizard that connects your tools and gets data flowing into Koalr.

When you first sign in, Koalr presents a guided setup wizard at /setup. The wizard walks you through three steps: connecting source control, adding optional integrations, and exploring your data.

The page header reads "Welcome to Koalr" with the subheading "Let's get you set up in 3 steps." A progress bar at the top tracks your position across the three steps.

Step 1: Connect your source control

The first step is titled "Connect your source control". Koalr requires at least one source control provider to generate deploy risk scores and DORA metrics.

Available providers

ProviderDescription
GitHubPull requests, CODEOWNERS, deployments, check runs
GitLabMerge requests, CI/CD pipelines, repositories

Click the Connect button next to GitHub or GitLab. A modal opens where you complete the OAuth authorization with the provider. You can connect both if your team uses both.

What gets synced

After you authorize, Koalr begins syncing immediately:

  • Last 90 days of pull requests and deployment events
  • CODEOWNERS files across all repositories
  • Open PRs scored 0-100 for deploy risk immediately
  • DORA metrics: deployment frequency, lead time, CFR, MTTR

Continuing to step 2

Once at least one provider shows a green Connected badge, the Continue to next step button appears. Click it to proceed.

If you want to explore without connecting a provider, click Skip for now -- explore the demo dashboard at the bottom of the step. This marks onboarding as complete and takes you to the Deploy Risk dashboard.

Step 2: Add more tools

The second step is titled "Add more tools". These integrations are all optional and improve the accuracy of deploy risk scores or unlock additional metrics. You can add any of them later from the Integrations page in Settings.

IntegrationDescriptionTag
JiraIssue cycle time, sprint velocity, lead time phasesRecommended
LinearIssue tracking, project cycle time--
SlackDeploy risk alerts, CODEOWNERS drift notifications, weekly digestRecommended
PagerDutyIncident correlation -- link incidents to the deploy that caused them--
incident.ioIncident management -- MTTR tracking and deploy-to-incident correlation--
CodecovCoverage delta in deploy risk score -- most critical signal after churnRecommended

Click Connect next to any integration to open its connection modal. Integrations marked Recommended have the most impact on deploy risk accuracy and team visibility.

When you are finished, click I'm done -- show me my data to proceed to step 3.

Step 3: Explore your data

The final step shows a confirmation screen with the heading "You're set up!" and the message: "Koalr is syncing your data. Your first deploy risk scores will appear within 60 seconds."

Four quick links are shown:

LinkDestinationDescription
Deploy Risk Dashboard/deploy-riskSee which PRs are high risk right now
DORA Metrics/doraDeployment frequency, lead time, CFR, MTTR
Pull Requests/pull-requestsRisk scores for all open PRs
Invite your team/settings/membersAdd engineers and managers

Click Go to Deploy Risk Dashboard to leave the wizard and start using Koalr. You can also click any of the quick links to jump directly to a specific page.

Re-running the wizard

The setup wizard is shown once per account. After completion, Koalr stores a flag locally and redirects new sessions to the dashboard. If you need to connect additional integrations later, go to Settings and click Integrations in the sidebar.

What's next