Code tree for GitHub and GitLab
JavaScript CSS HTML

README.md

Octotree

Browser extension (Chrome, Firefox, Opera and Safari) to show a code tree on GitHub and GitLab. Awesome for exploring project source without having to pull every single repository to your machine. Features:

  • Easy-to-navigate code tree, just like in IDEs
  • Fast browsing with pjax and Turbolinks
  • Support private repositories (see instructions)
  • Support GitHub and GitLab Enterprise (Chrome and Opera only, see instructions)

Octotree on GitHub Octotree on GitLab

Install on Chrome, Firefox and Opera

Note: to configure Octotree for GitHub and GitLab Enterprise, see instructions

Install on Safari

Octotree is not available on the Safari gallery. Instead, you must use the prebuilt package or build one from source.

Install from prebuilt packages (all browsers)

Prebuilt packages are available in the dist folder. For security reason, only download Octotree from this location.

Note: Firefox 43+ requires add-ons to be signed. Therefore, you should install Octotree from the Mozilla store. For some reason if you want to install the prebuilt package instead, you have to disable sign-check.

Settings

Access Token

Note for the paranoids (like me!): Octotree stores access tokens in your browser local storage and never transmits it anywhere. If you want to verify, check out the source, starting with this line.

GitHub

Octotree uses GitHub API to retrieve repository metadata. By default, it makes unauthenticated requests to the GitHub API. However, there are two situations when requests must be authenticated:

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 textbox. Note that the minimal scopes that should be granted are public_repo and repo (if you need access to private repositories).

GitLab

Octotree uses GitLab API to retrieve repository metadata. By default, Octotree attempts to retrieve the access token embedded in the GitLab DOM and use the token to authenticate against the GitLab API. If Octotree cannot retrieve the token, it will prompt you to create one.

Enterprise URLs

By default, Octotree only works on github.com and gitlab.com. To support enterprise version (Chrome and Opera only), you must grant Octotree sufficient permissions. Follow these steps to do so:

  • To add GitHub enterprise, go to any GitHub repo; otherwise, go to any GitLab repo (e.g. gitlab-ce).
  • Open the Octotree settings panel

Settings

  • Fill in the GitHub/GitLab Enterprise URLs textbox, one URL per line
  • Click Save and accept the permission prompt
  • Navigate to your GitHub/GitLab Enterprise site
  • You might be asked to create an access token

Others

  • Hotkeys: Octotree uses keymaster to register hotkeys. Checkout the supported keys.
  • Remember sidebar visibility: if checked, show or hide Octotree based on its last visibility.
  • Show in non-code pages: if checked, allow Octotree to show in non-code pages such as Issues and Pull Requests.
  • Load entire tree at once: if checked, load and render the entire code tree at once. To avoid long loading, this should be unchecked if you frequently work with very large repos.

Credits