Skip to main content

CLI tools for GitHub — follow back, unfollow, and more.

Project description

gh-social

CLI tools for GitHub — follow back, unfollow, and more.

A fast, modular toolkit for common GitHub operations. Includes Follow Back, Unfollow, and Follow Stargazers tools.

Tools

Tool Description
follow Follow all followers of any GitHub user
unfollow Unfollow users who don't follow you back
stargazers Follow users who starred a repository

Features

  • Interactive Menu — Run without arguments for a guided menu experience
  • Concurrent Execution — Uses ThreadPoolExecutor with 16 workers for fast API operations
  • Smart Bot Detection — Identifies spam/bot accounts using a 2-of-3 heuristic
  • Dry-Run Mode — Preview targets before executing any actions
  • Rate Limit Aware — Checks GitHub API rate limits before proceeding
  • JSON Output — Machine-readable output for scripting and automation

Requirements

  • Python 3.10+
  • GitHub CLI (gh) — must be installed and authenticated
  • rich >= 13.0 — modern terminal output

Authentication

The toolkit uses your gh CLI credentials:

gh auth login
gh auth refresh -h github.com -s user

Installation

Note: On Debian/Ubuntu 23.04+ the system Python is externally managed (PEP 668). Use a virtual environment or pipx to avoid installation errors.

With pipx (Recommended)

pipx install gh-social

From PyPI

pip install gh-social

From Source (Development)

git clone https://github.com/ajangsupardi/gh-social.git
cd gh-social
python3 -m venv .venv
source .venv/bin/activate
pip install -e .

Usage

Interactive Mode

Run without arguments to see the menu:

gh-social

CLI Mode

# Follow Back
gh-social follow ajangsupardi              # Dry-run
gh-social follow ajangsupardi --execute    # Execute
gh-social follow ajangsupardi --limit 100  # Limit

# Follow Stargazers
gh-social stargazers ajangsupardi/gh-social              # Dry-run
gh-social stargazers ajangsupardi/gh-social --execute    # Execute
gh-social stargazers ajangsupardi/gh-social --limit 50   # Limit

# Unfollow
gh-social unfollow                         # Dry-run
gh-social unfollow --execute               # Execute
gh-social unfollow --limit 100             # Limit

# Common flags
gh-social follow ajangsupardi --json       # JSON output
gh-social follow ajangsupardi --execute --include-bots

As Library

from gh_social.api import get_session, api_paginate, follow_user
from gh_social.models import enrich_users_concurrent

# Initialize session
get_session()

# Use API functions directly
followers = api_paginate("users/octocat/followers")
follow_user("octocat")

Flags

Flag Description Default
--execute Execute action (otherwise dry-run) false
--limit N Limit number of users processed 0 (all)
--include-bots Include bot accounts false
--json Output in JSON format false

How It Works

Follow Back

1. Authenticate via gh CLI token
2. Fetch target user's followers (paginated, concurrent)
3. Fetch your following list to identify already-followed users
4. Filter out: yourself, already-followed, and optionally bots
5. Enrich user details concurrently (name, bio, repos)
6. Display table preview (dry-run) or execute follows concurrently

Unfollow

1. Authenticate via gh CLI token
2. Fetch your followers & following lists (concurrent)
3. Find: users you follow who DON'T follow you back
4. Filter out: optionally bots
5. Enrich user details concurrently (name, bio, repos)
6. Display table preview (dry-run) or execute unfollows concurrently

Follow Stargazers

1. Authenticate via gh CLI token
2. Fetch stargazers of target repo (paginated, concurrent)
3. Fetch your following list to identify already-followed users
4. Filter out: yourself, already-followed, and optionally bots
5. Enrich user details concurrently (name, bio, repos)
6. Display table preview (dry-run) or execute follows concurrently

Bot Detection

Accounts are flagged as potential bots when 2 out of 3 conditions are met:

Condition Description
Default avatar Uses GitHub's default identicon
Empty bio No bio or whitespace only
Zero repos No public repositories

License

MIT License — see LICENSE for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gh_social-1.1.2.tar.gz (16.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gh_social-1.1.2-py3-none-any.whl (15.4 kB view details)

Uploaded Python 3

File details

Details for the file gh_social-1.1.2.tar.gz.

File metadata

  • Download URL: gh_social-1.1.2.tar.gz
  • Upload date:
  • Size: 16.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for gh_social-1.1.2.tar.gz
Algorithm Hash digest
SHA256 ddd49700f9ddd8ad8a8006483c5e17f3459aadef297d90768d6896cb2e5c3250
MD5 daabebb21229ed0c5403aa59d6f4e00b
BLAKE2b-256 35886a6333329bfb595b95d108e30e0d4dcaf099e44da3f813f5db799e75a5b8

See more details on using hashes here.

File details

Details for the file gh_social-1.1.2-py3-none-any.whl.

File metadata

  • Download URL: gh_social-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 15.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for gh_social-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f0d23600b2e3204621d772abc6cb3b9ce6d768bee2582c47eb3800109499c7f8
MD5 4ce71e1ba8120e0fda0cd7d6874d847c
BLAKE2b-256 ce63157f0b9fbc9cf10d931304817d0bb483ff3abd15c85ef3729d7014a9d8ea

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page