An open API service indexing awesome lists of open source software.

https://github.com/lineville/star-scraper

Utility to scrape info about repo stars
https://github.com/lineville/star-scraper

cli github nodejs stars

Last synced: about 1 year ago
JSON representation

Utility to scrape info about repo stars

Awesome Lists containing this project

README

          

# 🌟 Star Scraper [![npm version](https://badge.fury.io/js/star-scraper.svg)](https://badge.fury.io/js/star-scraper) ![crates.io](https://img.shields.io/crates/v/star-scraper.svg)

CLI tool and GitHub Action to get some basic stats about a repo's stars and how many of those stars come from members of that organization 👀

- Create a GitHub PAT (Personal Access Token) with `org:read` scope and set it as the `$GITHUB_TOKEN` environment variable

## Installation

```bash
yarn global add star-scraper
# or
# npm i -g star-scraper
# or
# cargo install star-scraper
```

![star-scraper](https://user-images.githubusercontent.com/25349044/175988348-fbb5f343-7faa-4fe1-a38f-d092296b522a.gif)

## Usage

```bash
star-scraper --org \
--repo \
--token \
--limit
```

- `--org`, `--repo` and `--token` are required.
- `--token` can optionally be supplied as an environment variable via `GITHUB_TOKEN`.
- `--limit` is optional and defaults to 100,000.

## Run as a GitHub action

- Fork this repo
- Set the `GH_TOKEN` actions secret on the repo
- Manually run the star gazer report workflow