GitTree User Guide

Q: Can I analyze any public repository?

Yes, any public GitHub repository. Very large repositories may have their tree truncated due to GitHub API rate limits and pagination constraints.

What is GitTree?

GitTree is a free, browser-based tool that fetches any public GitHub repository via the GitHub REST API v3 and renders its complete directory hierarchy as an interactive, searchable tree. Beyond simple navigation, it computes file-level statistics, generates distribution charts by language and file type, and provides structured export options — enabling developers, code reviewers, technical writers, and learners to understand project layout at a glance.

Because GitTree operates entirely client-side, your browser communicates directly with the GitHub API. No code is sent to or stored on any intermediate server. Analysis results are cached locally in your browser's storage to enable near-instant reloads of recently visited repositories.

Interactive Tree & Metrics

Visualize the full directory structure and repository statistics in a single view, with expand/collapse controls and real-time file search.

Language & File Distribution

Automatically groups files by extension and programming language, displaying proportional charts that reveal the technological composition of any project.

Zero Configuration

Paste a GitHub URL or user/repo shorthand and press Visualize. No sign-up, no API key, no browser extension required.

Getting Started in 3 Steps

1 Paste the GitHub URL

In the main field on the home page, paste any public GitHub repository URL.

Accepted formats:
• https://github.com/usuario/repositorio
• usuario/repositorio
• https://github.com/usuario/repositorio.git

2 Click "Visualize"

The tool will fetch the complete repository structure and process all information. The process may take a few seconds depending on the repository size.

3 Explore the Results

Navigate between the "Tree" and "Metrics" tabs to explore different views of the repository data.

Main Features

Tree View

The tree panel renders the full directory hierarchy fetched from the GitHub Trees API. Each node is individually expandable, and the toolbar above the tree provides controls for bulk operations:

Click on folders to expand/collapse
Use the search to find specific files
Expand/Collapse buttons to control the entire tree
Copy structure as text or Markdown

Tip: Use the "Copy Text" button in the toolbar to copy the structure in ASCII format and paste it in documentation.

Metrics Tab

The Metrics tab aggregates and presents quantitative insights about the repository, sourced directly from the GitHub API:

File and folder count
Total repository size
Distribution chart by file type
GitHub statistics (stars, forks, watchers)

What does each button do?

Input Field

Paste

Automatically pastes the repository link from the clipboard. Useful when you just copied a GitHub URL.

Visualize

Starts the repository analysis. Fetches the complete structure and processes all file and folder information.

Visualization

Tree

Shows the repository structure in hierarchical tree format. Allows expanding and navigating through all directories and files.

Metrics

Displays statistics and charts about the repository, including file count, total size, type distribution, and GitHub data.

Tools

Clear Cache

Removes all repositories saved in the local cache. Use when you want to free up space or force a new analysis.

Reload

Forces a new analysis of the current repository, ignoring the cache. Useful to see recent updates in the repository.

Export

JSON

Exports the complete structure in JSON format. Ideal for programmatic analysis or integration with other tools.

CSV

Exports the file list in CSV format (spreadsheet). Perfect for analysis in Excel, Google Sheets, or other data tools.

Tree Toolbar

Copy Text

Copies the tree structure in ASCII text format. Useful to include in documentation, READMEs, or to share the structure.

Expand

Expands all directories in the tree at once. Shows the complete repository structure.

Collapse

Collapses all directories, showing only the root level. Useful for a simplified overview.

Other Controls

Toggle Theme

Button in the upper right corner that switches between light and dark theme. Your preference is saved automatically.

Search Files

Search field above the tree to filter files in real time. Type any part of the file name or path.

Quick Tip: Hover over any button to see a quick description (tooltip) of what it does!

Advanced Tips

Quick Paste: Use the "Paste" button next to the input field to automatically paste links copied from the clipboard.

Smart Cache: GitTree stores analyses locally. Recently analyzed repositories load instantly.

Export Data: Use the "JSON" or "CSV" buttons to export the complete analysis for external use.

Light/Dark Theme: Click the moon/sun icon in the upper right corner to switch between themes.

Frequently Asked Questions

Q: Does GitTree work with private repositories?
A: No. GitTree uses the public GitHub REST API and does not support authentication tokens. Only public repositories are accessible.

Q: Is my data stored anywhere?
A: No server-side storage occurs. GitTree caches analysis results in your browser's localStorage only — data never leaves your device.

Q: Can I analyze any public repository?
A: Yes, any public GitHub repository. Very large repositories (thousands of files) may have their tree truncated due to GitHub API rate limits and pagination constraints.

Q: Is the tool free?
A: Yes, completely free, open-source, and ad-supported. No subscription or registration is required.

Q: Why is the tree loading slowly?
A: Response time depends on the GitHub API and the repository size. Large monorepos with thousands of files may take several seconds. Subsequent loads of the same repository are nearly instant thanks to the local cache.

Q: How do I report a bug or suggest a feature?
A: Open an issue on the GitHub repository. All feedback is reviewed and valued.