Browser extensions (Chrome, Firefox, Opera and Safari) 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)
- Install Octotree from Chrome Web Store, Mozilla Add-ons Store or Opera 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
The prebuilt packages for all extensions are located in the dist folder. For security reason, only download Octotree from this location.
- Safari: drag
safari.safariextzto the browser and follow on-screen the instructions
Note: the Safari build is out of date with the main line because Apple wants to be the only company who forces open-source developers to pay for the privillege of creating free extensions for their little-used browser.
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 developer console of your browser
- 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 and Opera, you must grant Octotree sufficient permissions. Follow these steps to do so:
- Navigate to any GitHub repository on
github.com - Open Octotree's settings panel
- Fill in the GitHub Enterprise URLs textbox, one URL per line
- Click Save and accept any permission prompt
- Navigate to your GitHub Enterprise site
- You might be asked to create an access token
- Fix bug long branches are not loaded correctly due to GitHub DOM change
- Fix space between tree and GitHub contents due to GitHub DOM change
- Support direct downloading when hovering a file
- Fix bug detecting branch/tag due to GitHub DOM change
- Fix bug when switching to branches with slashes in their names
- Fix branch selection no longer works due to GitHub change
- Update buttons' style to match GitHub new button style
- Update all dependencies to latest version
- Allow navigating to commit trees ovity#157
- Support keyboard navigation ovity#158
- Fix bug handling back tick in paths ovity#160
- Fix bug ovity#147
- Option to show in non-code pages
- Option to load tree only when sidebar is visible
- Option to configure tab size
- Bug fixes
- New header to match new GitHub design
- Bug fixes
- Support GitHub enterprise
- Change default hotkey (
cmd+bfor Safari andcmd+shift+sfor all other browsers) - Some other minor changes
- Setting panel allowing:
- Changing access token
- Changing hotkeys
- Changing sidebar default visibility
- Changing folder collapsing option
- Sidebar appears better in large monitors
- More responsive in big repositories
- And bug fixes
- Hide sidebar by default (upon many user requests)
- Hotkey (
cmd+b,ctrl+b) to toggle sidebar - Sidebar is now resizable
- Support rendering submodules
- Reflect GitHub selection to Octotree
- New sidebar header and progress indicator
- And bug fixes
- New UI that blends better with GitHub!
- Hide Octotree on non-code pages
- When asking for token, show more detailed message and not fly out automatically
- Extend pjax timeout to work better with big files
- Sanitize file and folder names before displaying
- Fix error when a branch name contains slashes
- Gulp script to build for Chrome, Firefox and Safari
- And some other minor changes
- Many thanks to all contributors who submit pull requests, report bugs and suggest ideas
- Extension icon by pstadler