Documentation

Getting Started

GitLogger is a powerful tool designed to help you visualize and understand the architecture, evolution, and history of any public GitHub repository.

  • Analyze a Repository: On the home page, simply paste a GitHub repository URL (e.g., https://github.com/facebook/react) and press Enter.
  • Ask the AI: Type a regular question instead of a URL on the home screen to instantly open a ChatGPT-style conversation. Our AI can help you understand architectures, git concepts, or anything else you're curious about!
  • Search Suggestions: Your recent searches are conveniently saved. Click the search bar at the top of any page to quickly jump back to a previously analyzed repository.

Navigating the Repository View

Once a repository is loaded, you have access to three main tabs:

  • Commits: A chronological timeline of all major commits. Clicking on a commit fetches real-time statistics showing how many files were modified, and the exact number of additions and deletions.
  • Issues: A streamlined view of the repository's open issues, complete with author information and comment counts. Clicking an issue opens it directly on GitHub.
  • Readme: A natively rendered version of the repository's `README.md` file so you can understand the project without leaving GitLogger.

Keyboard Shortcuts & Tips

Enhance your workflow with these tips:

  • Press / anywhere on the page to instantly focus the top search bar.
  • Clicking the Git Logger logo in the top left will clear your current session and return you to the pristine home screen.
  • Use the View on GitHub button on the repository overview to instantly open the repo in a new tab.