Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rednafi/fork-sweeper
Remove unused GitHub forks
https://github.com/rednafi/fork-sweeper
cli delete-forks forks github github-api go golang remove-forks
Last synced: 3 months ago
JSON representation
Remove unused GitHub forks
- Host: GitHub
- URL: https://github.com/rednafi/fork-sweeper
- Owner: rednafi
- Created: 2024-03-03T01:28:07.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-06-10T05:09:57.000Z (7 months ago)
- Last Synced: 2024-09-26T21:04:48.969Z (3 months ago)
- Topics: cli, delete-forks, forks, github, github-api, go, golang, remove-forks
- Language: Go
- Homepage:
- Size: 58.6 KB
- Stars: 23
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
fork
sweeper
|
\|/
-|-
// \\
/// \\\
//// \\\\
Remove unused GitHub forks
## Installation
- On macOS, brew install:
```sh
brew tap rednafi/fork-sweeper https://github.com/rednafi/fork-sweeper \
&& brew install fork-sweeper
```
- Elsewhere, go install:
```sh
go install github.com/rednafi/fork-sweeper/cmd/fork-sweeper
```
## Prerequisites
- Collect your GitHub API [access token]. The token will be sent as `Bearer ` 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=` command.
## Usage
- Run help:
```sh
fork-sweeper -h
```
```txt
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.
```sh
fork-sweeper --owner rednafi --token $GITHUB_TOKEN --older-than-days 0
```
This returns:
```txt
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:
```sh
fork-sweeper --owner rednafi --token $GITHUB_TOKEN --delete
```
- You can explicitly protect some repositories from deletion with the `--guard` parameter:
```sh
fork-sweeper --owner "rednafi" --token $GITHUB_TOKEN --older-than-days 0 --guard 'py'
```
This prints:
```txt
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:
```sh
fork-sweeper --owner rednafi --token $GITHUB_TOKEN --max-page 200 --per-page 100
```
[access token]:
https://docs.github.com/en/rest/authentication/authenticating-to-the-rest-api?apiVersion=2022-11-28