Where to Find GhostTrack Documentation: A Complete Guide to the OSINT Tool

GhostTrack documentation is maintained entirely within the HunxByts/GhostTrack GitHub repository, with the README.md providing quick‑start guidance and GhostTR.py serving as the canonical reference for all implementation details.

GhostTrack is a lightweight Python CLI tool designed for OSINT investigations, offering IP address tracking, phone number lookup, and social media username enumeration through a simple text‑menu interface. Unlike complex frameworks that maintain separate documentation sites, this project follows a source‑code‑as‑documentation approach where every function, dependency, and usage pattern is self‑contained within the repository files. Understanding where to find GhostTrack documentation requires examining three specific files that collectively cover installation, architecture, and operational logic.

Primary Documentation Files

The repository contains three essential files that constitute the complete documentation for GhostTrack.

README.md

The README.md file located at the repository root provides the entry‑point documentation. It contains installation steps, prerequisite requirements, and visual screenshots demonstrating the menu interface. For users seeking immediate setup instructions, this file offers the fastest path to running the tool.

GhostTR.py Source Code

According to the GhostTrack source code, the GhostTR.py file is the primary technical reference. This single Python script contains all functionality including the console UI loop (option(), run_banner(), main()), the option registry (options list), and all tracking implementations. Each public function is decorated with @is_option and includes inline comments explaining its operation.

requirements.txt

Dependencies are documented in requirements.txt, which lists the external Python packages required for operation. The file specifies requests for HTTP operations and phonenumbers for phone number parsing, with no version pinning so that latest stable releases are used.

Architecture Overview

Understanding the internal structure requires examining specific functions within GhostTR.py.

Console UI and Menu System

The user interface operates through a loop defined in main() that clears the terminal, displays a stylized banner via run_banner(), and presents a numbered menu. The option() function handles user input dispatch, while is_in_options() validates selections against the options registry—a list of dictionaries mapping numeric selectors to callable functions. The helper functions call_option() and execute_option() manage the execution flow and gracefully handle ValueError and KeyboardInterrupt exceptions.

IP Tracking Implementation

The IP_Track() function prompts for an IP address and queries the ipwho.is public API. It parses the JSON response to display geo‑location data including country, city, ASN, ISP, and generates a Google Maps link. The showIP() function similarly queries api.ipify.org to reveal the machine's public IP address.

Phone Number Analysis

Phone lookup functionality resides in phoneGW(), which utilizes the phonenumbers library to parse international formats. This function extracts location, carrier information, validation status, time zones, and provides both national and international formatting options.

Username Enumeration

Social media tracking is implemented in TrackLu(), which constructs URLs for platforms including Facebook, Twitter, Instagram, and GitHub. The function performs synchronous HTTP requests using the requests library to verify profile existence via status codes, marking URLs as "found" on HTTP 200 responses.

Installation and Usage Examples

Deploying GhostTrack requires only standard Python tooling and the documented dependencies.

Setup Commands


# Clone the repository

git clone https://github.com/HunxByts/GhostTrack.git
cd GhostTrack

# Install required Python packages

pip3 install -r requirements.txt

# Run the tool

python3 GhostTR.py

IP Address Lookup

Selecting option 1 from the menu invokes the IP tracker:

Enter IP target : 8.8.8.8

============= SHOW INFORMATION IP ADDRESS =============
IP target       : 8.8.8.8
Type IP         : IPv4
Country         : United States
...
Maps            : https://www.google.com/maps/@37,-122,8z

Phone Number Investigation

Option 3 triggers the phone analysis module:

Enter phone number target Ex [+6281xxxxxxxxx] : +14155552671

========== SHOW INFORMATION PHONE NUMBERS ===========
Location             : United States
Region Code          : US
Timezone             : America/Los_Angeles, ...
Operator             : AT&T
Valid number         : True
...
International format : +1 415-555-2671

Username Tracking

Option 4 executes the social media enumeration:

Enter Username : johndoe

========== SHOW INFORMATION USERNAME ===========
[ + ] Facebook   : https://www.facebook.com/johndoe
[ + ] Twitter    : https://www.twitter.com/johndoe
[ + ] Instagram  : https://www.instagram.com/johndoe
[ + ] GitHub     : https://www.github.com/johndoe

Summary

  • GhostTrack documentation is self‑contained within the HunxByts/GhostTrack repository, requiring no external wiki or website.
  • The README.md provides installation instructions and visual references for new users.
  • GhostTR.py serves as the definitive technical manual, containing all implementation logic for IP tracking (IP_Track()), phone lookup (phoneGW()), and username enumeration (TrackLu()).
  • requirements.txt documents the minimal dependency footprint consisting of requests and phonenumbers.
  • All network operations use free public APIs (ipwho.is, api.ipify.org) requiring no authentication keys.
  • The @is_option decorator wraps each command to automatically display the banner before execution.

Frequently Asked Questions

Where is the official GhostTrack documentation hosted?

The official documentation exists only within the GitHub repository at HunxByts/GhostTrack. There is no separate documentation website; users should reference the README.md for setup instructions and GhostTR.py for technical implementation details.

How do I install GhostTrack and its dependencies?

Clone the repository and install the Python packages listed in requirements.txt using pip3. The tool requires only the requests and phonenumbers libraries, which are standard packages available via PyPI.

Can I use GhostTrack without API keys?

Yes. As implemented in the source code, GhostTrack utilizes free public endpoints including ipwho.is for IP geolocation and api.ipify.org for public IP detection. The username tracking function performs direct HTTP requests to social media platforms without requiring authentication.

Which function handles phone number validation in GhostTrack?

The phoneGW() function within GhostTR.py handles all phone number operations. It uses the phonenumbers library to parse international formats, validate numbers, extract carrier information, and determine geographic location and time zones.

Have a question about this repo?

These articles cover the highlights, but your codebase questions are specific. Give your agent direct access to the source. Share this with your agent to get started:

Share the following with your agent to get started:
curl -s "https://instagit.com/install.md"

Works with
Claude Codex Cursor VS Code OpenClaw Any MCP Client

Maintain an open-source project? Get it listed too →