Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/clyrisai/gitresolve/llms.txt

Use this file to discover all available pages before exploring further.

GitResolve is an npm library and CLI tool that turns messy candidate submissions — portfolio URLs, GitHub links, and resume PDFs — into clean, structured developer profiles. Feed it a URL or a PDF and get back a typed result with the candidate’s git identity, owned repositories, contributions, and a confidence score, ready to plug into any recruiting pipeline.

Quickstart

Resolve your first candidate profile in under 2 minutes using the CLI or TypeScript API.

CLI Guide

Full reference for all CLI flags, batch processing, output options, and provider selection.

API Reference

TypeScript API docs for scrapePortfolio, parseResume, createProvider, and all exported types.

Browser Providers

Configure fetch, Puppeteer, or Browserless to match your infrastructure and rendering needs.

What GitResolve Does

1

Classifies the input

Every input — a URL, a file path, a GitHub link — is classified into a type (portfolio, git_profile, repo_url, resume_file, etc.) before any processing begins.
2

Fetches or parses the source

Portfolio and profile URLs are scraped using your configured browser provider (fetch, Puppeteer, or Browserless). Resume PDFs are parsed via text extraction and hyperlink annotation extraction.
3

Extracts all git links

Every GitHub, GitLab, and Bitbucket URL found in the page HTML or PDF content is extracted and classified as a profile, repo, pull request, issue, or gist.
4

Disambiguates ownership

A cross-referencing algorithm determines which profile belongs to the candidate, separating owned repos from external references and contributions.
5

Returns a typed result

Every call returns a ResolverResult with ownerProfile, confidence, ownedRepos, contributions, externalRepos, allLinks, and warnings.

Supported Input Types

InputExampleWhat Happens
Portfolio sitehttps://janedoe.devScrapes page for git links
GitHub profilehttps://github.com/janedoeScrapes profile, discovers repos
GitLab profilehttps://gitlab.com/janedoeScrapes profile, handles /users/ routes
Bitbucket profilehttps://bitbucket.org/janedoeScrapes profile page
Repo URLhttps://github.com/user/repoScrapes repo page, resolves owner
PR / Issue URLhttps://github.com/user/repo/pull/42Extracted as a contribution
Resume PDF./resume.pdf or remote URLExtracts text + hyperlink annotations

Browser Providers

GitResolve supports three strategies for fetching page content. The right choice depends on your infrastructure:
ProviderJS RenderingBest For
puppeteer✅ FullSPAs, JavaScript-heavy portfolio sites
browserless✅ FullServer environments, CI/CD pipelines
fetch❌ NoneStatic sites, always-available fallback

Concepts

Learn how GitResolve classifies inputs, disambiguates candidates, and structures results.

Installation

Install via npm, pnpm, yarn, or bun — or run on-demand with npx.

Build docs developers (and LLMs) love