Skip to main content
This guide walks you through signing up for Detail, installing the GitHub App, and reviewing the findings from your first scan. By the end, you’ll have an initial batch of bugs and security vulnerabilities in your codebase.

​
Prerequisites

  • A GitHub account with access to at least one repository you want to scan.
  • Access to app.detail.dev. Sign up for free if you don’t have an account yet.

​
Steps

1

Sign up at app.detail.dev

Navigate to app.detail.dev and click Sign in with GitHub. Detail uses GitHub OAuth; no separate password is required.Once authenticated, Detail creates your account and takes you to the onboarding flow.
2

Install the Detail GitHub App

During onboarding, Detail prompts you to install the Detail GitHub App. Click Install GitHub App to open the GitHub App installation page.On that page, choose whether to grant access to all repositories or select specific repositories you want Detail to monitor, then click Install. GitHub redirects you back to app.detail.dev when installation is complete.
You can add or remove repository access at any time in your GitHub organization settings.
3

Wait for your first scan

Back in the Detail UI, select the repositories you want Detail to scan. Your first scan starts shortly after installation and will take a few hours. When it finishes, Detail will email you with findings.You can monitor progress on the Scans page in the dashboard. You’ll see the scan status update to Complete when findings are ready.
4

Review your findings in the dashboard

Navigate to the Bugs page in the dashboard. Detail displays a list of findings ordered by when they were introduced, with the newest first.Each finding includes:
  • Title: a concise description of the problem.
  • Summary: a detailed explanation of what the bug is, why it’s a problem, and where it lives in your code.
  • File path: the exact location of the bug.
  • **Commit and Author: **the commit that introduced the issue, and an original author who is likely to have context. You can use the author for routing.
  • Security flag: a badge if the finding is classified as a security vulnerability.
Use the Status filter to toggle between open, resolved, and dismissed findings.
5

Resolve your first bug

Click any finding from the table to see the full bug contents. From here you can manually share it, copy a fix prompt for your agent of choice, or mark its final status:
  • Resolve: Click **Resolve **once you’ve fixed the underlying code. Detail records the resolution and removes the finding from your open list.
  • **Dismiss: **Click Dismiss and choose a reason. Add an optional note to leave context for your teammates and for the Detail agent. Dismissed findings are hidden from the default view but remain searchable.
If you’ve sent bugs to Linear, Jira, GitHub, or Asana, resolving the associated ticket will automatically update the status in Detail.

​
Next steps

You’ve connected your repository and triaged your first finding. Here’s where to go from here:

Bug Finder

Understand how Detail’s AI scanner works and how to tune signal quality for your codebase.

Dashboard & Workflow

Learn how to filter, sort, and bulk-triage findings to keep your bug backlog under control.

CLI Overview

Install the Detail CLI to trigger scans and review findings without leaving your terminal.

API Overview

Pull findings into your own tooling or automate triage using the Detail public REST API.