✴    ✴   ✴              ✴       ✴              ✴                ✴
  ✴  _      ✴      ✴   ✴        _    ✴              ✴   ✴     _   ✴  
 ___| |_ __ _ _✴__ _ __ ___  __| |    ___ ✴___  __ _ _✴__ ___| |__  
/ __| __/ _` | '✴_| '__/ _ \/ _` |  ✴/ __|/ _ \/✴_` | '__/ __| '_ \✴
\__ \ || (✴| |✴|  | | |  __/ (_| | ✴ \__ \  __/ (_| | | | (__| |✴| |✴
|___/\__\__,_|_|  |_| ✴\___|\__,_|___|___/\___|\__✴_|_| ✴\___|_| |_|
          ✴            ✴        |_____|      ✴       ✴

Search your starred ★ repositories on GitHub from your terminal

You know those repositories you like and star into the abyss? Yes those, this cli tool will help you do a fuzzy search on them. You can search any GitHub user's starred repositories by providing their handle only.

This tool will cache the results locally so that you don't risk abusing the API requests limit.

"Starred Search Demo"

Notice: This project is still in alpha and the API might change without notice. Update only after reviewing the changelog for breaking changes.

Installation

Minimum Requirements

🐧 Linux
🍎 macOS
📦 Node v12.x.x+

Setup

# Install
npm install starred_search -g

# Usage
starred_search --user 'link-' --find 'es6'

I recommend that you create an alias in your shell to avoid repeating the required parameters.

Example alias in fish and bash:

# Create an alias (this is temporary, you might want to make it permanent)
alias stars="starred_search --user 'link-'"

# Then you can use it as:
stars -f 'es6'

Usage

Usage: starred_search [OPTIONS] [ARGS]...

  Search your or any other user's starred repositories on GitHub for a keyword.

Options:
  -h, --help
    Show this message and exit.

  -u, --user <handle>
    Any GitHub handle. Example: link-

  -c, --cache-dir <directory>
    Directory you want to store the cache file in. Example: /tmp/.cache

  -f, --find <keyword>
    The keyword you want to search for. Example: es6

  -o, --org <org name>  (optional)
    GitHub organisation name. Example: GitHub

  -l, --limit <number>
    Limit the search results to the specified number. Default is 10

  -V, --verbose
    Outputs debugging log

  -v, --version
    Outputs release version

  -d, --debug
    Outputs stack trace in case an exception is thrown

Non-verbose output

starred_search --user 'link-' --find 'es6'

[
  {
    "repo_name": "lukehoban/es6features",
    "repo_description": "Overview of ECMAScript 6 features",
    "repo_url": "https://github.com/lukehoban/es6features",
    "repo_stars": 27672
  },
  {
    "repo_name": "google/sa360-flightsfeed",
    "repo_description": "Generate SA360 compatible feeds for airlines on BigQuery  :rocket:",
    "repo_url": "https://github.com/google/sa360-flightsfeed",
    "repo_stars": 8
  },
  {
    "repo_name": "DrkSephy/es6-cheatsheet",
    "repo_description": "ES2015 [ES6] cheatsheet containing tips, tricks, best practices and code snippets",
    "repo_url": "https://github.com/DrkSephy/es6-cheatsheet",
    "repo_stars": 11410
  }
]

Verbose output & override cache directory

starred_search --user 'link-' --cache-dir '/tmp/.cache' --find 'es6' --verbose

🕵    INFO: Searching for "es6" in "link-'s" starred catalogue
⚠️    INFO:: Serving search results from cache
[
  {
    "repo_name": "lukehoban/es6features",
    "repo_description": "Overview of ECMAScript 6 features",
    "repo_url": "https://github.com/lukehoban/es6features",
    "repo_stars": 27672
  },
  {
    "repo_name": "google/sa360-flightsfeed",
    "repo_description": "Generate SA360 compatible feeds for airlines on BigQuery  :rocket:",
    "repo_url": "https://github.com/google/sa360-flightsfeed",
    "repo_stars": 8
  },
  {
    "repo_name": "DrkSephy/es6-cheatsheet",
    "repo_description": "ES2015 [ES6] cheatsheet containing tips, tricks, best practices and code snippets",
    "repo_url": "https://github.com/DrkSephy/es6-cheatsheet",
    "repo_stars": 11410
  }
]

Parsing the output with jq

You can pipe the standard output to be handled by tools like jq for more magic:

# Return the first search result only
starred_search -u 'link-' -f 'es6' | jq '.[0]'

{
  "repo_name": "lukehoban/es6features",
  "repo_description": "Overview of ECMAScript 6 features",
  "repo_url": "https://github.com/lukehoban/es6features",
  "repo_stars": 27672
}

# Return repo_name of every result element
starred_search -u 'link-' -f 'es6' | jq 'map(.repo_name)'

[
  "lukehoban/es6features",
  "google/sa360-flightsfeed",
  "DrkSephy/es6-cheatsheet"
]

Using a personal access token to increase the API rate limit

You can use a personal access token to increase the API rate limit from 60 requests per hour to 5000 requests per hour. Learn more about personal access tokens here.

# Assuming you're using a bash shell
export GITHUB_TOKEN="ghp_1234567890"
starred_search -u 'link-' -f 'es6'

{
  "repo_name": "lukehoban/es6features",
  "repo_description": "Overview of ECMAScript 6 features",
  "repo_url": "https://github.com/lukehoban/es6features",
  "repo_stars": 27672
}

Release History

0.1.12
- <input checked="" disabled="" type="checkbox"> Update packages to resolve security vulnerabilities
0.1.11
- <input checked="" disabled="" type="checkbox"> Fix repo_url value to reference the Repository's GitHub URL
- <input checked="" disabled="" type="checkbox"> Default homepage_url to N.A
0.1.10
- <input checked="" disabled="" type="checkbox"> Add release workflow
- <input checked="" disabled="" type="checkbox"> Add contributing guide
0.1.9
- <input checked="" disabled="" type="checkbox"> Replaced the flaky fuzzy search with an enhanced full text search
- <input checked="" disabled="" type="checkbox"> Updated cache invalidation logic to rely on etags
- <input checked="" disabled="" type="checkbox"> Add -d, --debug option
- <input checked="" disabled="" type="checkbox"> Automatic discovery of cache directory based on OS
- <input checked="" disabled="" type="checkbox"> Updates user agent for API requests
0.1.8
- <input checked="" disabled="" type="checkbox"> API BREAKING CHANGES
- <input checked="" disabled="" type="checkbox"> Change alias for --verbose from -v to -V
- <input checked="" disabled="" type="checkbox"> Add -v, --version option
0.1.7
- <input checked="" disabled="" type="checkbox"> Added -h, --help option
- <input checked="" disabled="" type="checkbox"> Added -l, --limit option to limit the search results
0.1.6
- <input checked="" disabled="" type="checkbox"> Added aliases to documentation
0.1.5
- <input checked="" disabled="" type="checkbox"> API BREAKING CHANGES
- <input checked="" disabled="" type="checkbox"> Add verbose flag
- <input checked="" disabled="" type="checkbox"> Fix output to return valid JSON
- <input checked="" disabled="" type="checkbox"> Fix output to return results in an array instead of separated objects
0.1.0 - 0.1.4
- <input checked="" disabled="" type="checkbox"> Basic functionality

Package detail

starred_search

readme