Skip to content

ahmadawais/github-stars-contributions

Repository files navigation

github-stars-contributions

Log your GitHub Stars Contributions from the command line.


DOWNLOADS Learn Node.js CLI Automation Follow @_ahmadawais on X


CLI: github-stars-contributions gsc

πŸ‘¨β€πŸ« Awais taught and created this CLI project in his NodeCLI.com automation course

  • πŸ“¦ Add a contribution of any type
  • πŸ—ƒοΈ Remove a contribution in case of a mistake
  • 🀯 Autocomplete search with type and filter function
  • 🀯 Adding YouTube? gsc CLI can fetch title, date, and description for you
  • πŸ‘¨β€πŸ« Awais taught and created this CLI project in his NodeCLI.com automation course

πŸ“Ÿ

Install

# Recommended.
npx github-stars-contributions

# OR an alternative global install.
npm install -g github-stars-contributions
gsc # run global alias

βš™οΈ

Usage

The CLI supports both interactive (default) and non-interactive modes for automation.

Add Contributions

πŸ’¬ Interactive Mode (Default)

Run gsc add and answer the prompts:

ADD

gsc add
# OR
gsc a

You'll be asked:

  • Contribution Type
  • URL (optional)
  • Title
  • Description
  • Date

πŸ€– Non-Interactive Mode (Automation)

Perfect for CI/CD pipelines and scripts:

gsc add \
  -t BLOGPOST \
  -T "My Blog Post" \
  -D "Description here" \
  -d 2025-11-22 \
  -u https://example.com \
  -x

Remove Contributions

πŸ’¬ Interactive Mode (Default)

Search and select contributions to remove:

Remove gif

gsc remove
# OR
gsc r

Search for the contribution, select it, and press enter to remove. Easy peasy!

πŸ€– Non-Interactive Mode (Automation)

Remove by contribution ID:

gsc remove -i <contribution-id> -x

βš™οΈ

Command Reference

help gif

Basic Syntax

github-stars-contributions <command> [options]
# OR
gsc <command> [options]

Global Options

Option Description
-v, --version Output the version number
-h, --help Display help for command

Commands

Command Alias Description
add [options] a Add a new contribution (interactive by default)
remove [options] r Remove a contribution (interactive by default)
help [command] - Display help for command

add Command

Add a new contribution to your GitHub Stars profile.

Usage:

gsc add [options]
gsc a [options]

Options:

Option Description Required
-t, --type <type> Contribution type (see types below) Yes (non-interactive)
-T, --title <title> Contribution title Yes (non-interactive)
-D, --description <description> Contribution description Yes (non-interactive)
-d, --date <date> Date in YYYY-MM-DD format (default: today) Yes (non-interactive)
-u, --url <url> Contribution URL No
-x, --no-interactive Disable interactive mode No
-h, --help Display help No

Contribution Types:

  • OTHER
  • FORUM
  • SPEAKING
  • BLOGPOST
  • HACKATHON
  • VIDEO_PODCAST
  • ARTICLE_PUBLICATION
  • EVENT_ORGANIZATION
  • OPEN_SOURCE_PROJECT

Examples:

# Interactive mode (default)
gsc add

# Non-interactive mode with all options
gsc add \
  -t BLOGPOST \
  -T "My Blog Post" \
  -D "Description here" \
  -d 2025-11-22 \
  -u https://example.com \
  -x

# Non-interactive without URL
gsc add -t SPEAKING -T "Conference Talk" -D "Talked about Node.js" -d 2025-11-20 -x

remove Command

Remove a contribution from your GitHub Stars profile.

Usage:

gsc remove [options]
gsc r [options]

Options:

Option Description Required
-i, --id <id> Contribution ID to remove Yes (non-interactive)
-x, --no-interactive Disable interactive mode No
-h, --help Display help No

Examples:

# Interactive mode (default) - search and select
gsc remove

# Non-interactive mode with ID
gsc remove -i abc123 -x

πŸ“

Changelog

❯ Read the changelog here β†’

KEY: πŸ“¦ NEW, πŸ‘Œ IMPROVE, πŸ› FIX, πŸ“– DOC, πŸš€ RELEASE, and πŸ€– TEST

I use Emoji-log, you should try it and simplify your git commits.


πŸ“ƒ

License & Conduct


πŸ™Œ

Connect

GitHub @AhmadAwaisΒ (follow) To stay up to date on free & open-source software

Twitter @_AhmadAwaisΒ (follow) To get #OneDevMinute daily hot tips & trolls

YouTube AhmadAwaisΒ (subscribe) To tech talks & #OneDevMinute videos

Blog: AhmadAwais.comΒ (read) In-depth & long form technical articles

LinkedIn @_AhmadAwaisΒ (connect) On the LinkedIn profile y'all

About

Log your GitHub Stars Contributions with the ease of a command line CLI

Topics

Resources

Code of conduct

Stars

Watchers

Forks

Packages

No packages published