https://github.com/emirxmertoglu/gh-repo-cleaner

A Node.js script to bulk delete GitHub repositories while preserving selected ones.
https://github.com/emirxmertoglu/gh-repo-cleaner

github-api nodejs repository-management

Last synced: 3 days ago
JSON representation

A Node.js script to bulk delete GitHub repositories while preserving selected ones.

• Host: GitHub
• URL: https://github.com/emirxmertoglu/gh-repo-cleaner
• Owner: emirxmertoglu
• License: mit
• Created: 2025-02-09T16:43:13.000Z (5 days ago)
• Default Branch: main
• Last Pushed: 2025-02-09T16:59:59.000Z (5 days ago)
• Last Synced: 2025-02-09T17:34:08.361Z (5 days ago)
• Topics: github-api, nodejs, repository-management
• Language: JavaScript
• Homepage:
• Size: 0 Bytes
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🚀 gh-repo-cleaner

A simple and efficient Node.js script to **delete multiple GitHub repositories at once** while ensuring that specified repositories are **protected from deletion**.

## ✨ Features

- Fetches **all** repositories from your GitHub account (handles pagination).

- **Excludes specific repositories** from deletion using an escape list.

- Deletes repositories **sequentially** to avoid hitting GitHub API rate limits.

- Provides **clear logs** on which repositories were deleted and which failed.

## 📌 Prerequisites

- **Node.js** (v14 or later)

- **[A GitHub Personal Access Token](https://github.com/settings/tokens)** with `repo` and `delete_repo` permissions.

## 🚀 Installation & Usage

### 1️⃣ Clone the repository

```sh

git clone https://github.com/emirxmertoglu/gh-repo-cleaner.git

cd gh-repo-cleaner

```

### 2️⃣ Install dependencies

Since this script only uses **Axios**, you can install it via:

```sh

yarn install

```

### 3️⃣ Configure your credentials

Open `index.js` and replace the placeholders:

```javascript

const GITHUB_ACCESS_TOKEN = "your_personal_access_token";

const USERNAME = "your_github_username";

const ESCAPE_LIST = ["repo1", "repo2", "repo3"];

```

### 4️⃣ Run the script

```sh

node index.js

```

### 📌 Important Notes

- This **action is irreversible**! Double-check the `ESCAPE_LIST` before running the script.

- GitHub imposes **rate limits** on API requests. If you have too many repositories, you might hit these limits.

## 🤝 Contributing

Feel free to **fork** this repository and submit **pull requests**. Any contributions, whether fixing bugs, optimizing code, or adding features, are welcome!

## 🐟 License

This project is licensed under the **MIT License**.

## 📚 Sources

- [List repositories for a user](https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#list-repositories-for-a-user)

- [Delete a repository](https://docs.github.com/en/rest/repos/repos?apiVersion=2022-11-28#delete-a-repository)