Firefox Browser Add-ons
Log in
Preview of Github Aid - repo file size

Github Aid - repo file size by omar-azmi

Displays github repository file and folder sizes. Supports GraphQL and REST api modes. Also mobile friendly.

5 (1 reviews)5 (1 reviews)
29 Users29 Users
You'll need Firefox to use this extension
Download Firefox
Download file

Extension Metadata

Screenshots
Feature list: view file and folder sizes, view repo size, download selected filesConfiguration options: set your github access token, select api method, setup layout of utility buttonsBuilt for mobile and dekstop compatibility
About this extension
This is an open source extension that lets you view the sizes of Github repository content. In the future, it will also let you download multiple files from within your browser.


Features:
- Preview a Repository's entire Disk Space usage (which includes git history)
- Preview the sizes of individual files and folders under the directory
- Ability to choose between github's REST api, or GraphQL api
- Ability to set an Access Token to view your private repository stats
- Buttons that are added to the page are customizable (and can be turned off)
- Display is optimized for both mobile and desktop browsers
- Open source: checkout the source code on github: https://github.com/omar-azmi/github_aid_ts

Planned features:
- Add support for selecting files and folders, then queuing them for download in a ".tar.gz" archive
- Add support for defaulting to REST api and disabling access token in Incognito mode

Permissions required:
- Access to running background javascript in all github.com pages
- Access to storage for storing your access token, and saving your configuration settings


Problems you may encounter:

1) The buttons are not appearing
- Refresh the page. Github is an SPA (single-page application), so there are times when the background script does not get reloaded upon navigation from one page to another.
- Make sure that you did not disable all buttons in the option page's layout section. If you're having touble, consider clicking on the red "reset" button to clear any misconfigurations and return to factory settings.
- Make sure that storage permission has been granted to this extension, otherwise the script will fail to load the default configuration, and terminate fatally.

2) One of the buttons flashes in red, and nothing happens.
- This is because the request query sent to github's server has failed, possibly due to one of the following reasons:
- Github's server is overloaded, and it decided to reject your request (quite common). In this case, try switching your api method in the options page, and reload your webpage and retry.
- You are viewing a private repo, and the access token that you have (or may lack) is not authorized for pulling up data of that private repository
- Your Github Access Token key is invalid, or has expired
- You (and your Token) have reached their per hour request limit, or that you've been sending too many requests too quickly. The request data rate for github is: 50 requests per hour for non-authorized tokenless users, and 5000 per hour for authorized users. Moreover, the REST api in this extension used 2 requests for fetching file and folder sizes
- There might be a bug in the code, or github's api might have changed. In that case, I'd appreciate if you could open up an issue on github: https://github.com/omar-azmi/github_aid_ts/issues


Guide on how to get a Github Access Token:

1) First of all, you'll need to be logged into your github account.
2) Navigate to github's "Generate new token (classic)" page: https://github.com/settings/tokens/new
3) Set an "Expiration" date, (you'll probably want to choose "No expiration")
4) In the "Select scopes" section, under the "repo" checkbox:
- enable only the "public_repo" checkbox if you will NOT be viewing your private repository's stats
- enable the whole "repo" group checkbox otherwise
5) Scroll to the bottom and click on the "Generate token" button
6) You will now be presented with the access token. Make sure to copy and save it securely! This is a one time preview of you key, and it disappear forever after you've closed the dialog
7) Paste the token into this browser extension

For a visual guide, see one of:
- https://www.geeksforgeeks.org/how-to-generate-personal-access-token-in-github/
- https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens

But remember NOT to check any scope boxes besides the "repo" one.
Having anything else checked is dangerous if your access key gets leaked from your browser storage, and someone decides to maliciously delete your projects.
Rated 5 by 1 reviewer
Log in to rate this extension
There are no ratings yet

Star rating saved

5
1
4
0
3
0
2
0
1
0
Read 1 review
Permissions and dataLearn more

Required permissions:

  • Access your data for github.com
More information
Add-on Links
  • Homepage
  • Support site
  • Support Email
Version
0.1.2
Size
198.26 kB
Last updated
2 years ago (6 Feb 2024)
Related Categories
  • Web Development
  • Appearance
Licence
GNU Lesser General Public Licence v3.0 only
Version History
  • See all versions
Add to collection
Report this add-on
More extensions by omar-azmi
  • There are no ratings yet

  • There are no ratings yet

  • There are no ratings yet

  • There are no ratings yet

  • There are no ratings yet

  • There are no ratings yet

Go to Mozilla's homepage

Add-ons

  • About
  • Firefox Add-ons Blog
  • Extension Workshop
  • Developer Hub
  • Developer Policies
  • Community Blog
  • Forum
  • Report a bug
  • Review Guide

Browsers

  • Desktop
  • Mobile
  • Enterprise

Products

  • Browsers
  • VPN
  • Relay
  • Monitor
  • Pocket
  • Bluesky (@firefox.com)
  • Instagram (Firefox)
  • YouTube (firefoxchannel)
  • Privacy
  • Cookies
  • Legal

Except where otherwise noted, content on this site is licensed under the Creative Commons Attribution Share-Alike Licence v3.0 or any later version.