Quickstart: Resolve Your First Git Profile with GitResolve

Go from zero to a resolved GitHub profile in minutes. This guide covers the GitResolve CLI, resume PDF parsing, and the TypeScript programmatic API.

This guide walks you through resolving your first candidate profile using GitResolve. You’ll run the CLI against a live GitHub profile URL, parse a local resume PDF, and then wire up the programmatic TypeScript API for use inside your own application — all with zero required configuration.

ResolverResult Shape

Every resolved input — whether a portfolio URL, a profile link, a repo URL, or a resume PDF — returns a ResolverResult object with this shape:

interface ResolverResult {
  source: string;
  sourceType: InputType;
  ownerProfile: ExtractedGitLink | null;
  confidence: "high" | "medium" | "low" | "none";
  ownedRepos: ExtractedGitLink[];
  contributions: ExtractedGitLink[];
  externalRepos: ExtractedGitLink[];
  allLinks: ExtractedGitLink[];
  warnings: string[];
  error?: string;
}

ResolverResult Fields

Field	Type	Description
source	string	The original input — a URL or a file path
sourceType	InputType	Classified type: portfolio, git_profile, repo_url, resume_file, resume_url, linkedin, or unknown
ownerProfile	ExtractedGitLink | null	The best resolved git profile for the candidate; null if unresolvable
confidence	"high" | "medium" | "low" | "none"	How confident GitResolve is in the ownerProfile resolution
ownedRepos	ExtractedGitLink[]	Repos where the username matches the resolved owner — the candidate’s own projects
contributions	ExtractedGitLink[]	Explicit PR and Issue links extracted — signals open-source activity
externalRepos	ExtractedGitLink[]	Repos owned by other users that the candidate has referenced
allLinks	ExtractedGitLink[]	Every git link found, unfiltered and uncategorized
warnings	string[]	Non-fatal issues encountered during resolution (e.g. skipped LinkedIn links)
error	string | undefined	Set if a fatal error occurred during processing

What’s Next

CLI Guide

Explore all CLI flags including batch processing with —portfolios, —resumes, and —output-dir.

API Reference

Full reference for every exported function and type in the programmatic API.

Browser Providers

Learn how to configure Puppeteer, Browserless, and the fetch provider for different environments.

Installation

All install options, environment variables, and TypeScript setup details.