fork
sweeper
|
\|/
-|-
// \\
/// \\\
//// \\\\


Remove unused GitHub forks

Installation

• On macOS, brew install:

  brew tap rednafi/fork-sweeper https://github.com/rednafi/fork-sweeper \
      && brew install fork-sweeper

• Elsewhere, go install:

  go install github.com/rednafi/fork-sweeper/cmd/fork-sweeper

Prerequisites

• Collect your GitHub API access token. The token will be sent as Bearer <token> in the HTTP header while making API requests.
• The token must have write and delete access to the forked repos.
• Set the GITHUB_TOKEN to your current shell environment with export GITHUB_TOKEN=<token> command.

Usage

• Run help:

  fork-sweeper -h

  Usage of fork-sweeper:
    -delete
          Delete forked repos
    -guard value
          List of repos to protect from deletion (fuzzy match name)
    -max-page int
          Maximum number of pages to fetch (default 100)
    -older-than-days int
          Fetch forked repos modified more than n days ago (default 60)
    -owner string
          GitHub repo owner (required)
    -per-page int
          Number of forked repos fetched per page (default 100)
    -token string
          GitHub access token (required)
    -version
          Print version

• List forked repos older than n days. By default, it'll fetch all forked repositories that were modified at least 60 days ago. The following command lists all forked repositories.

  fork-sweeper --owner rednafi --token $GITHUB_TOKEN --older-than-days 0

  This returns:

  Fetching forked repositories for rednafi...
  
  Guarded forked repos [won't be deleted]:
  
  Unguarded forked repos [will be deleted]:
      - https://github.com/rednafi/cpython
      - https://github.com/rednafi/dysconfig
      - https://github.com/rednafi/pydantic

• The CLI won't delete any repository unless you explicitly tell it to do so with the --delete flag:

  fork-sweeper --owner rednafi --token $GITHUB_TOKEN --delete

• You can explicitly protect some repositories from deletion with the --guard parameter:

  fork-sweeper --owner "rednafi" --token $GITHUB_TOKEN --older-than-days 0 --guard 'py'

  This prints:

  Fetching forked repositories for rednafi...
  
  Guarded forked repos [won't be deleted]:
      - https://github.com/rednafi/cpython
      - https://github.com/rednafi/pydantic
  
  Unguarded forked repos [will be deleted]:
      - https://github.com/rednafi/dysconfig

  The --guard parameter can be passed multiple times to filter out multiple repos.

• By default, the CLI will fetch 100 pages of forked repositories with 100 entries on each page. If you need more, you can set the page number as follows:

  fork-sweeper --owner rednafi --token $GITHUB_TOKEN --max-page 200 --per-page 100