Files
github-recon/README.md
T
Hadi be6a9fbc6b add badges
Signed-off-by: Hadi <[email protected]>
2025-05-09 23:54:11 +02:00

2.0 KiB

GH-Recon

Latest Release GoDoc GoReportCard

Project Overview

Fetches and aggregates public OSINT data for a GitHub user, leveraging Go and the GitHub API.

Features

  • Retrieve basic user profile information (username, ID, avatar, bio, creation dates)
  • List organizations and roles
  • Fetch SSH and GPG keys
  • Enumerate social accounts
  • Extract unique commit authors (name + email) in both chronological orders

Disclaimer

This tool is intended for educational purposes only. Use responsibly and ensure you have permission to access the data you are querying.

Prerequisites

  • Go 1.18+
  • GitHub Personal Access Token (recommended for higher rate limits)

Installation

With Go

go get github.com/anotherhadi/gh-recon

With Nix/NixOS

From anywhere (using the repo URL):

nix run github:anotherhadi/gh-recon -- --username TARGET_USER [--token YOUR_TOKEN]

Permanent Installation:

# add the flake to your flake.nix
{
  inputs = {
    gh-recon.url = "github:anotherhadi/gh-recon";
  };
}

# then add it to your packages
environment.systemPackages = with pkgs; [ # or home.packages
  gh-recon
];

Usage

gh-recon --username TARGET_USER [--token YOUR_TOKEN]

Flags

  • --username: GitHub username to inspect (required)
  • --token: Personal Access Token (optional but recommended)

Example

gh-recon --username anotherhadi --token ghp_ABC123...

Todo

Feel free to contribute! Here are some ideas:

  • Fetch names in License files
  • Fetch emails in README files/comments