Skip to main content
This guide walks you through signing up for Detail, installing the GitHub App on your repositories, and reviewing the findings from your first scan. By the end, you’ll have a live view of bugs and security vulnerabilities in your codebase and know how to act on them.

​
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. Grant the requested permissions to allow Detail to read your profile and confirm your identity.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. Select the 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 by visiting Settings → Integrations → GitHub in the Detail dashboard, or by managing the app directly in your GitHub organization settings.
3

Wait for your first scan

Detail automatically schedules a nightly scan for each connected repository. Your first scan starts shortly after installation.If you’d rather not wait, trigger an on-demand scan immediately:
  1. Open the Repositories page in the dashboard.
  2. Find your repository and click Scan now.
  3. Detail queues the scan and shows a live status indicator. Most scans complete within a few minutes, depending on repository size.
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 and commit — the exact location and the commit that introduced the issue.
  • 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

Triage your first bug

Click any finding to open its detail view. From here you have two options:
  • Resolve it — Click Mark as resolved once you’ve fixed the underlying code. Detail records the resolution and removes the finding from your open list.
  • Dismiss it — Click Dismiss and choose a reason: not_a_bug, wont_fix, duplicate, or other. Add an optional note to leave context for your teammates. Dismissed findings are hidden from the default view but remain searchable.
Resolving a finding in Detail does not automatically close linked issues in Linear, Jira, or GitHub — but if you’ve connected those integrations, status changes sync bidirectionally so your issue tracker stays up to date.

​
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.