Search your starred ★ repositories on GitHub from your terminal
✴ ✴ ✴ ✴ ✴ ✴ ✴
✴ _ ✴ ✴ ✴ _ ✴ ✴ ✴ _ ✴
___| |_ __ _ _✴__ _ __ ___ __| | ___ ✴___ __ _ _✴__ ___| |__
/ __| __/ _` | '✴_| '__/ _ \/ _` | ✴/ __|/ _ \/✴_` | '__/ __| '_ \✴
\__ \ || (✴| |✴| | | | __/ (_| | ✴ \__ \ __/ (_| | | | (__| |✴| |✴
|___/\__\__,_|_| |_| ✴\___|\__,_|___|___/\___|\__✴_|_| ✴\___|_| |_|
✴ ✴ |_____| ✴ ✴
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.
Notice: This project is still in alpha
and the API might change without notice. Update only after reviewing the changelog for breaking changes.
v12.x.x+
# 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: 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
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
}
]
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
}
]
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"
]
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
}
repo_url
value to reference the Repository's GitHub URLN.A