Browser extension (Chrome, Firefox, Opera and Safari) to show a code tree on GitHub. Awesome for exploring project source without having to pull every single repository to your machine. Features:
Note: to configure Octotree for GitHub Enteprise, see instructions
Octotree is not available on the Safari gallery. You have to build from source. Download this repo and run the following command:
Find the extension folder in
tmp/safari. Follow Apple instructions to install the extension to your browser.
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.
Note for the paranoids (like me!): Octotree stores access tokens in your browser local storage and never transmits it anywhere.
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
repo (if you need access to private repositories).
Octotree uses Bitbucket API to retrieve repository metadata. By default, Octotree asks for your Bitbucket App password. If you don't already have one, create one (the minimal requirement is
Read permission), then copy and paste it into the textbox.
Note that Octotree extracts your username from the current page to invoke the Bitbucket API. If fail to do so, Octotree will ask you for a token update, you just need to prepend your username to the token, separated by a colon, i.e.
By default, Octotree only works on
github.com. To support enterprise version (Chrome and Opera only), you must grant Octotree sufficient permissions. Follow these steps to do so:
Loving Octotree? Donating to help us continue working on it.
Become a sponsor and get your logo on our README on Github with a link to your site. [Become a sponsor]