---
updatedAt: 2026-09-22T19:51:50.000Z
agentTools:
  projectIndex: https://docs.waydev.co/llms.txt
---

# Start Guide

## Before you begin

Make sure you have the following ready:

* **Admin access to Waydev** — You'll need workspace admin permissions to configure integrations, manage users, and adjust settings.
* **Credentials for your developer tools** — Have authentication tokens or OAuth access ready for the services you plan to connect (source control, issue tracking, AI coding tools, etc.).
* **Your team hierarchy data** — An org chart, spreadsheet, or HRIS export showing who belongs to which team and who the team leads are.

***

## Setting up Waydev

### <Anchor target="_blank" href="https://docs.waydev.co/v5.0/docs/integrations">1. Connect your integrations</Anchor>

Waydev centralizes engineering data by connecting to the tools your team already uses. This is the foundation for everything else—without at least one integration, there's no data to report on.

To add an integration, navigate to **Settings → Integrations** in the left sidebar, then click **+ Add Integration** in the top-right corner. In the **Provider** dropdown, search for or select the service you want to connect, then follow the authorization steps for that provider.

Waydev supports a wide range of providers, including **Azure Boards, Azure DevOps, Claude Code, Cursor, Devin, GitHub, GitHub Copilot, GitLab, Jira, Slack Bot, and Windsurf**.

Once connected, each integration appears in the Integrations table with its current status, last sync time, and a summary of synced data. You can use the **Actions** menu (`···`) on any row to test the connection, view details, or remove the integration. The bottom of the page also shows an aggregate **Stats** panel covering total repositories, projects, user identities, and sync success rate across all your connections.

> **Note:** Waydev recommends connecting source control, issue tracking, and AI coding tools to get the most complete picture of your engineering workflow.

***

### <Anchor target="_blank" href="https://docs.waydev.co/v5.0/docs/teams">2. Set up your team hierarchy</Anchor>

Mirroring your org chart in Waydev ensures that data is routed to the right managers and that insights are actionable at the team level.

Navigate to **Settings → Teams** to manage your team structure. Teams in Waydev can be nested to reflect real-world reporting lines—for example, a **Devs** team can contain **Frontend** and **Backend** sub-teams. You can expand or collapse nested teams directly in the table.

To create a team, click **+ Create Team** in the top-right corner and fill in the following fields:

* **Name** — The display name for the team.
* **Team Lead** — Select the person responsible for this team.
* **Parent Team** — Optionally assign a parent team if this team sits within a larger group.

Click **Create team** to save. Repeat this process until your hierarchy reflects your organization's structure.

***

### <Anchor target="_blank" href="https://docs.waydev.co/v5.0/docs/users">3. Add users</Anchor>

Navigate to **Settings → Users** to manage who has access to Waydev. To add a new user, click **+ Add user** and fill in their name, email address, role, and primary team.

Each user can be assigned one or more roles that control their permissions and access levels. Once users are added, you can manage their details, team assignment, and linked accounts from the user's detail page under **Settings → Users → \[user name]**.

***

### <Anchor target="_blank" href="https://docs.waydev.co/v5.0/docs/users#link-user-accounts">4. Link user accounts</Anchor>

Once your integrations and users are in place, link each user's Waydev profile to their accounts in connected tools—such as their GitHub handle, Jira email, or Cursor username. This ensures that activity data from each integration maps to the correct person in reports.

Waydev links users automatically by email when possible. For cases where automatic linking doesn't apply, navigate to **Settings → Users → Link accounts** to manually assign accounts from each integration to the right user.

***

### <Anchor target="_blank" href="https://docs.waydev.co/v5.0/docs/teams">5. Organize users into teams</Anchor>

Teams allow you to aggregate users across team boundaries for reporting and filtering purposes, useful when you want to analyze a cross-functional cohort, a role-based segment, or an initiative-specific set of contributors.

To create a group, navigate to **Settings → Users & Teams → Teams** and click **+ Create team**. Fill in the following:

* **Name** — A name to identify this group.
* **Team lead**
* **Parent team -&#x20;**&#x69;f needed.

***

### <Anchor target="_blank" href="https://docs.waydev.co/v5.0/docs/user-attributes">6. Add attributes</Anchor>

Attributes let you define custom properties for users, enabling richer segmentation and filtering in reports. For example, you might add attributes like Seniority, Location, or AI assistant usage to track patterns across different cohorts.

Navigate to **Settings → Attributes** and click **+ Create Attribute**. Give the attribute a descriptive name and define its possible values—type each option and press **Enter** to add it. At least one value is required to save the attribute.

There are three types of attributes in Waydev. **Admin-managed** attributes are created and controlled by an admin. **Waydev-managed** attributes are predefined by Waydev (such as Seniority, with values like Junior, Mid-Level, and Senior) and cannot be edited. **Self-reported** attributes are generated through snapshots or studies and filled in by users themselves.

Once attributes are created, assign values to individual users from the **Attributes** tab on each user's detail page.

***

### <Anchor target="_blank" href="https://docs.waydev.co/v5.0/docs/deploy-incident-rules">7. Configure data detection rules</Anchor>

Data detection rules tell Waydev how to identify deployments and incidents in your repositories. This is what powers DORA metrics—without detection rules, Waydev cannot calculate deployment frequency, lead time for changes, change failure rate, or mean time to restore.

Navigate to **Settings → Aggregation → Deploy & Incident Rules** and click **+ Add Rule**. Choose one of three detection types:

**PR merge** works well when merging into a specific branch directly triggers a release. Configure the release branch (e.g. `main`), an optional incident keyword to flag failed deployments (matched against the PR title or branch name), a service identifier for grouping in DORA metrics, and the repositories this rule applies to.

**API push** is the right choice when you have custom release tooling or need full control over what counts as a deployment. Waydev receives deployment signals directly via API. You'll need a Personal Access Token (PAT) to use this method—refer to the [API documentation](#) for details on the `/deployments` endpoint.

**Repository Tag** works well when tagging a commit signals a release, treating repository tags or releases as deployment events. Configure a release tag pattern to specify which tag names signal a release (e.g. `^v[0-9]+\.[0-9]+\.[0-9]+$`, or leave blank to match all tags), a service identifier for grouping in DORA metrics, an optional incident detection field to flag failed deployments (criteria are OR-ed, so a PR or its linked issue matching any rule flags the related deploy as a failure), and the repositories this rule applies to (select repository groups to auto-fill, or pick repositories directly).

**Note that each repository can only be assigned to one detection rule at a time.**

***

## <Anchor target="_blank" href="https://docs.waydev.co/v5.0/docs/entire-integration">8. Setting up the Entire integration</Anchor> (optional)

If your team uses AI agents during development and you want full traceability of AI-assisted sessions alongside commits, you can set up the Entire integration. Entire captures AI agent sessions in your Git workflow, enabling searchable history and better auditability of AI-generated changes.

Install Entire using one of the following methods:

```bash
# Option A: Shell script
curl -fsSL https://entire.io/install.sh | bash

# Option B: Homebrew
brew tap entireio/tap && brew install entireio/tap/entire
```

Once installed, enable Entire in your repository:

```bash
entire enable --local --skip-push-sessions --telemetry=false
```

This creates a `.entire` directory with configuration files. The local settings file (`.entire/settings.local.json`) controls the active configuration—confirm that `commit_linking` is set to `"always"` to ensure sessions are tied to commits.

To connect Entire with Waydev's commit tracking, add the `wd_commit_hook` file to your repository's `.githooks` folder and configure Git to use it:

```bash
git config core.hooksPath .githooks
```

Run `entire status` to verify everything is running correctly before moving on.

***

## Next steps

Once your integrations, users, teams, and detection rules are in place, explore Waydev's reporting capabilities:

### AI reports

The **AI** section covers AI ROI, AI Impact (including token usage and code-to-production metrics), and AI Checkpoints. These reports help you understand how AI coding tools are affecting your team's output and where they're delivering the most value.

### Delivery reports

The **Delivery** section includes DORA metrics (Deployment Frequency, Lead Time for Changes, Change Failure Rate, and Mean Time to Restore), PR Insights, and Sprints Commitment. These reports are powered by your integrations and detection rules and give you a complete picture of how software is being delivered.

### Health reports

The **Health** section covers Insights, Benchmarks, and Merge Quality—helping you identify patterns, compare your team against industry benchmarks, and spot potential quality risks before they become problems.

### Planning reports

The **Planning** section provides visibility into ticket lifecycle, sprint commitments, and work-in-progress—connecting engineering activity to project planning data from your issue tracker.