Skip to main content
GitResolve supports three output modes that can be used individually or in combination. The default terminal display is great for interactive use, --json makes it easy to pipe results into other tools, and --output-dir writes clean per-candidate files suitable for downstream automation.

Terminal Display (Default)

When neither --json nor --output-dir is provided, GitResolve prints an ANSI-colored summary table to your terminal. Each processed candidate gets one row with their resolved username, confidence level, number of owned repos, contributions, and any warnings. A summary line is printed at the end showing total resolved and unresolved counts.
The terminal display is suppressed when --json is active, keeping stdout clean for piping.

--json Mode

The --json flag suppresses all terminal UI output and prints the full results as a JSON array to stdout. Each element is an AggregatedResult object. This is the recommended mode when feeding GitResolve output into another tool or script.
Combine --json with jq for quick field extraction:

--output-dir Mode

The --output-dir <dir> flag writes one JSON file per candidate to a directory on disk. GitResolve creates two subdirectories automatically:
  • <dir>/resolved/ β€” one <username>.json file per successfully resolved candidate
  • <dir>/unresolved/ β€” one <sanitized_source>_N.json file per candidate that could not be resolved

Output Directory Structure

Each file contains the full AggregatedResult JSON for that candidate. Unresolved filenames are derived from the first source’s basename with non-alphanumeric characters replaced by underscores, followed by an incrementing counter.
The resolved/ and unresolved/ subdirectories are created automatically. You do not need to create them in advance.

Combining --json and --output-dir

Both flags can be used together. When combined, GitResolve writes per-candidate JSON files to disk and prints the full JSON array to stdout simultaneously. This is useful for saving a permanent archive while also piping the results into a downstream script in one step.
The two outputs are independent β€” the files on disk are not affected by what you pipe stdout into.

AggregatedResult Schema

Every output mode produces AggregatedResult objects. The table below describes every field. Each link object inside ownedRepos, contributions, externalRepos, and allLinks has the following shape:

Confidence Levels

A confidence of "none" does not always indicate an error. LinkedIn URLs, unknown input types, and pages with no Git links all produce "none" by design. Check the warnings array for a human-readable explanation.