Browser extensions (Chrome, Firefox, Safari and Opera) to display GitHub code in tree format. Useful for developers who frequently read source in GitHub and do not want to download or checkout too many repositories. Features:
- Easy-to-navigate code tree like IDEs
- Fast browsing with pjax
- Customizable hotkey
- Support private repositories (see instructions)
- Support GitHub Enterprise (Chrome and Opera only, see instructions)
- Download and install Octotree from Chrome Web Store or Mozilla Add-ons Store
- Navigate to any GitHub repository (or just refresh this page as an example)
- The code tree should show on the left-hand side of the screen
You can install the prebuilt extensions located in the dist folder. For security reason, only download Octotree from this location.
- Safari: drag
safari.safariextzto the browser and follow the instructions - Opera: drag
opera.nexto the browser and follow the instructions
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:
- You access a private repository
- You exceed the rate limit of unauthenticated requests
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).
Alternatively, you can manually enter or update the token by following these steps:
- Navigate to any GitHub repository
- Open the Chrome (or Safari, Firefox) developer console
- Execute the following line:
localStorage.setItem('octotree.github_access_token', 'REPLACE WITH TOKEN')Note: if you use GitHub Enterprise, each site will need its own access token. Therefore, Octotree stores access token on a per-site basis.
By default, Octotree only works on github.com. To support GitHub Enterprise on Chrome or Opera, you must grant Octotoree sufficient permissions. Follow these steps to do so:
- Navigate to any GitHub repository on
github.com - Open Octotree's setting panel
- Fill in the GitHub Enterprise URLs textbox, one site URL per line
- Click Save and accept any permission prompt
- Navigate to your GitHub Enterprise site (or refresh if you're already in one)
- You might be asked to create an access token
- Fix bug ovity#147