https://github.com/yashraj-n/github-size

A Simple Lightweight Tool to check size of any Github Repository
https://github.com/yashraj-n/github-size

Last synced: 4 days ago
JSON representation

A Simple Lightweight Tool to check size of any Github Repository

• Host: GitHub
• URL: https://github.com/yashraj-n/github-size
• Owner: yashraj-n
• License: mit
• Created: 2022-10-07T05:41:10.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-10-07T05:44:31.000Z (over 2 years ago)
• Last Synced: 2024-04-24T05:30:45.654Z (9 months ago)
• Language: JavaScript
• Size: 3.91 KB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        



	Github-Size



A Simple Lightweight Tool to check size of any Github Repository


## ⚡️ Quick start

Install the CLI using npm or yarn

```bash

npm i -g github-size

# or 

yarn global add github-size

```

## ⚙️ Usage

```bash

github-size 

```

Example:

```bash

github-size https://github.com/torvalds/linux

```

Output:

```bash

4.21 GB

```

## 📝API

```javascript

const {getRepoDetails}  =  require("../api");

const url  = "https://github.com/torvalds/linux";

getRepoDetails(url).then((size) => console.log(size)); // 4.21 GB

```

## License

[MIT](https://choosealicense.com/licenses/mit/)