About
Browser extension that brings GitHub experience to the next level. This repository contains the source code of Octotree Core. You can build and run it locally to access all features of the free version. Or you can download the full version on our website. Octotree supports Chrome, Firefox, Opera and Safari.
Settings
Access Token
Octotree uses the GitHub API to retrieve repository metadata. By default, it makes unauthenticated requests to get these data. However, there are two situations when GitHub require such requests to be authenticated:
- You access a private repository
- You exceed the API rate limit
When that happens, Octotree will ask for your GitHub personal access token. If you don't already have one, create one, then copy and paste it into the token textbox in the Settings screen. Note that the minimal scopes that should be granted are public_repo and repo (if you need access to private repositories).
No BS Policy: Octotree doesn't collect/share/care about your data at all. It stores the access token in your browser local storage and uses it only to communicate with GitHub API (see the code that does that here).
Access tokens are stored in the browser's local storage, only enter access tokens when you use a trusted computer.
Multiple Access Tokens (Pro)
If you have multiple GitHub accounts with access to different private repositories, you can let Octotree know which access token to use for which account. When you login to GitHub with an account, Octotree will use the matching token to make API requests to GitHub. If you don't login to GitHub or if the account you login is not in the account list, Octotree will use the default access token.
Go to Settings and click the + icon to add more accounts. Similar to access token, these accounts and tokens are stored in the browser's local storage.
Hotkeys
Hotkeys to pin or unpin the sidebar. You can enter multiple hotkeys by separating them with a comma.
- Supported modifiers:
⇧,shift,option,⌥,alt,ctrl,control,command, and⌘. - Supported special keys:
backspace,tab,clear,enter,return,esc,escape,space,up,down,left,right,home,end,pageup,pagedown,del,deleteandf1throughf19.
Learn more at keymaster.
Others
- Show sidebar on hover. If checked, hover the Octotree button to open the sidebar. Otherwise, click the button to open the sidebar.
- Lazy-load code tree. By default, Octotree loads everything in a single API request to render the full code tree. If you frequently work with big repositories, you should select this option so that Octotree only loads and renders the code tree lazily.
- Show file-type icons. If checked, show different icons for different file types.
- Show only pull request changes. If checked, show only the change set of the current pull request. Otherwise, show the full code tree. If a PR has more than 300 files, only 300 are shown.
- Enable Octotree in pages (Pro). Control the GitHub pages in which Octotree shows up.
- Cache repositories locally (Pro). Whether to cache the repository file structure in local machine cache (via browser Cache API). This significantly speeds up subsequent visits to large repositories and reduces the number of API requests to GitHub.
Pro Features
The following features require Pro subscription.
GitHub Enterprise
Note: GitHub Enterprise is not supported on Safari.
Follow these steps to enable Octotree for GitHub Enterprise:
- Navigate to any repository on github.com (not GitHub Enterprise)
- Open the Octotree sidebar
- Click the login link in the footer (or in Settings view)
- Login using your Octotree account
- Navigate to your GitHub Enterprise domain
- Right-click the Octotree icon the browser bar (see image below) select "Enable Octotree on this domain"
Lazy-load a specific repository
Activate lazy-loading for specific repositories by clicking the ⚡️ icon in the Octotree sidebar header.
Lazy-loading is helpful when you work with a big repositories (e.g. Linux, Kubernetes). The downside is it requires Octotree to make an API request and render every subdirectory as you click on the directory. This feature allows you to activate lazy-load for only certain repositories.
Enhanced code review
In the Pull Request page, Octotree shows file comments and file view status. The "Show non-file comments" group shows those comments that are added to the pull request, not to individual files. The file view status displayed in the Octotree sidebar helps you review large pull requests easier.
Multiple themes
Click the theme icon located at the bottom of Octotree to select a color theme. The "Only Sidebar" theme changes the Octotree sidebar to the dark theme without changing the theme of the GitHub page. This is helpful if you already use another mechanism to show GitHub in dark mode.
Change docking position
Click the dock icon at the footer of Octotree to change the sidebar location to the right or left of the screen.
Repo/PR/issue/file bookmark
You can click the bookmark icon next to a repository, pull request, issue or file name to bookmark it. You can view the list of bookmarks by clicking the bookmark icon in Octotree header.
File search
Click the search icon to start file search.
Note that when lazy-loading is used, search only works with directories and files that were already loaded.
View full PR changed file
Sometimes, it's necessary to view the entire changed file in a pull request. But keep clicking "Expand" is a pain. Octotree solves that. You can click the "View full" button at the top of each file in a pull request to view its entire content and all the diffs.
Collapse tree
Click the collapse tree icon at the Octotree sidebar header to collapse the code tree.
Browser Permissions
Octotree Core (built from source from this repo) requires some browser permissions:
- Read/change data in
github.comandapi.github.com: needed to show Octotree and make requests to GitHub API storage: needed to store Octotree settings
The full version of Octotree requires these additional permissions:
- Read/change data in
octotree.io: needed to authenticate users and load/store bookmarks from Octotree API contextMenus: needed to show Octotree context menu itemsactiveTab: needed for context menu actions to trigger enabling/disabling Octotree in GitHub Enterprise domains
The following permissions are optional and only requested when you enable Octotree in a GitHub Enterprise domain (*):
webNavigation: needed to inject Octotree sidebar in GitHub Enterprise domainstabs: needed to inject Octotree sidebar in GitHub Enterprise domains
*: when enabling Octotree in a GitHub Enterprise domain, Chrome displays the prompt for the "Read your browsing history" permission. That's a bit confusing as Octotree doesn't request the history permission or collect your data at all. See this discussion for more details. Firefox, on the other hand, is clearer about the specific permissions being requested by Octotree.
Credits
Octotree uses the following open-source software: