MapnosticsDOCS
← Back to Main Site
DocsGetting StartedQuick Start

Quick Start

From zero to full codebase intelligence in under 5 minutes. Connect your GitHub repository, run the analysis, and explore all 8 intelligence modules.

Overview

Watch the full onboarding flow step by step. The guide auto-advances — or click any step to jump directly.

mapnostics.com/dashboard
Quick Start Guide
From zero to full intelligence in 5 minutes
5 STEPS
STEP 01
Sign in with GitHub
STEP 02
Connect a repository
STEP 03
Wait ~2 minutes
STEP 04
Explore the 8 modules
STEP 05
Share a report
STEP 01
Sign in with GitHub
Click "Sign in with GitHub" on the login page. Mapnostics requests read-only access to your repositories — we never write to your repo.

1. Connect your repository

Sign in with GitHub at mapnostics.com/login. Mapnostics requests read-only access — we never modify your repository, create commits, or push branches.

NOTE
Both public and private repositories are supported. Public repos are available on the Free plan. Private repos require Pro or Team.

2. Run the analysis

After connecting a repo, click "Analyze now" from the dashboard. The indexer will:

  • Read every file through the GitHub API — nothing is cloned and nothing is written back.
  • Read the last commit date for each file, which the Zombie Code analysis uses to judge staleness.
  • Build the full import/export dependency graph.
  • Run all 8 intelligence modules in batched parallel requests.

Most repositories complete in under 2 minutes. Repositories with 1000+ files may take up to 5 minutes on first index.

3. Explore the modules

Start with the Health Score tab for a fast overview. Then explore the modules relevant to your current work:

  • Doing a refactor? Check the Impact Simulator first.
  • Onboarding a new engineer? Use the Onboarding Map.
  • About to deploy? Run Secrets Detection.
  • Codebase feels heavy? Sort by Dead Code confidence and start deleting.

4. Share a report

Click "Share Report" from any module page to generate a public link. The report includes your health score, all module findings, and a technical debt estimate. No login required for viewers.

5. Set up Autopilot

Autopilot re-indexes your repository every day at 9:00 UTC and posts a run summary — files changed, health score, dead code count — to your Slack webhook. Enable it per repository under the repo's Settings → Autopilot, and set the webhook in the same page's Notifications section.

TIP
The first week, just explore. Run the Impact Simulator before every change. By the second week, you will wonder how you ever coded without it.