# Octotree — GitHub Code Tree Navigation Extension

> A browser extension that adds an IDE-like file tree sidebar to GitHub repositories for faster code browsing and navigation.

## Install

Save in your project root:

# Octotree — GitHub Code Tree Navigation Extension

## Quick Use
```
Install from Chrome Web Store or Firefox Add-ons.
Search "Octotree" and click Add to Browser.
Open any GitHub repository — a file tree sidebar appears on the left.
```

## Introduction
Octotree adds a familiar file tree sidebar to GitHub, giving developers an IDE-like navigation experience when browsing repositories in the browser. Instead of clicking through directories one level at a time, you can see and jump to any file in the project instantly.

## What Octotree Does
- Displays a collapsible file tree panel on the left side of any GitHub repository page
- Enables quick file search and navigation within the tree
- Supports lazy-loading of large repositories to keep performance smooth
- Provides code bookmarking for frequently accessed files
- Works with GitHub Enterprise in addition to github.com

## Architecture Overview
Octotree is a browser extension built with JavaScript that injects a sidebar panel into GitHub pages. It uses the GitHub API to fetch the repository file tree and renders it as an interactive tree component. The extension caches tree data locally to reduce API calls and handles pagination for repositories with thousands of files.

## Self-Hosting & Configuration
- Install from Chrome Web Store, Firefox Add-ons, or Edge Add-ons
- Optionally provide a GitHub personal access token for higher API rate limits
- Configure sidebar width, hotkey, and appearance in the options page
- Add GitHub Enterprise domains to extend functionality to private instances
- The free version covers most features; a Pro version adds additional capabilities

## Key Features
- Instant file tree sidebar for any GitHub repository
- File search within the tree using fuzzy matching
- Pull request code review with file-level navigation
- Bookmark files across repositories for quick access
- Lazy loading handles repositories with tens of thousands of files

## Comparison with Similar Tools
- **Gitako** — lightweight tree sidebar; Octotree adds bookmarks and PR review features
- **GitHub's built-in file tree** — GitHub added a basic tree in 2022; Octotree offers more features like search and bookmarks
- **Refined GitHub** — focuses on UI improvements across GitHub; Octotree specializes in file navigation
- **Sourcegraph Extension** — adds code intelligence and cross-repo search; Octotree focuses on tree navigation

## FAQ
**Q: Does Octotree work with private repositories?**
A: Yes. You need to provide a personal access token with repo scope in the extension settings.

**Q: Is Octotree free?**
A: The core file tree feature is free. Octotree Pro adds code bookmarking, multiple tabs, and other advanced features for a subscription.

**Q: Does it work with GitHub Enterprise?**
A: Yes. Add your Enterprise domain in the settings and provide an appropriate access token.

**Q: How does Octotree handle very large repositories?**
A: It uses lazy loading and caching to fetch directory contents on demand rather than loading the entire tree at once.

## Sources
- https://github.com/ovity/octotree
- https://www.octotree.io

---
Source: https://tokrepo.com/en/workflows/asset-7e3d616c
Author: AI Open Source