Skip to content
Merged

2.7 #21

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: Bug report
about: Create a report
title: ''
labels: bug
assignees: Knuspii

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. Linux Ubuntu]
- Terminal:


**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: Knuspii

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
5 changes: 3 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# 🚀 How Can you Contribute?
## 1. Adding New Programs/Caches
The most common way to contribute is by adding support for more applications.
* Open the cc_caches.go file.
* Locate the getPrograms() function
* Add a new Program struct to the slice.
* **Important:** Ensure you provide paths for both Windows and Linux where possible.
* Use filepath.Join and environment variables (like localAppData) and maintain cross-platform compatibility.

## 2. Improving the UI/TUI
## 2. Improving the TUI
I aim for a "Crunchy" retro terminal feel. Improvements to the menu navigation, spinner, or banner are welcome, provided they don't add external dependencies.

## 3. Bug Reports & Feature Requests
Expand All @@ -22,7 +23,7 @@ If you find a bug or have an idea:
## 📥 Pull Request Process
* Fork the repository and create your branch from main.
* Test your changes! Run a dry-run (-d) to ensure paths are detected correctly.
* Commit with descriptive messages (e.g., "Add Spotify cache support").
* Commit with descriptive messages (e.g., "Add: Spotify cache support").
* Open a PR and describe what your changes do and why they are necessary.

## ⚖️ License
Expand Down
52 changes: 29 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
<p align="center">
<img src="https://img.shields.io/badge/maintenance-actively--developed-brightgreen.svg" />
<a href="https://goreportcard.com/report/github.com/knuspii/crunchycleaner/v2"><img src="https://goreportcard.com/badge/github.com/knuspii/crunchycleaner/v2" alt="Go Report Card" /></a>
<a href="https://github.com/knuspii/crunchycleaner/actions/workflows/go.yml"><img src="https://github.com/knuspii/crunchycleaner/actions/workflows/go.yml/badge.svg" alt="Build" /></a>
<a href="https://github.com/knuspii/crunchycleaner/stargazers"><img src="https://img.shields.io/github/stars/knuspii/crunchycleaner?style=social" alt="GitHub Stars" /></a>
<br>
<img src="https://img.shields.io/github/downloads/knuspii/crunchycleaner/total?color=green?" />
<img src="https://img.shields.io/badge/Platform-Windows%20%7C%20Linux-blue?logo=linux&logoColor=white" alt="Platform" />
<a href="https://github.com/knuspii/crunchycleaner/actions">
<img src="https://img.shields.io/github/actions/workflow/status/knuspii/crunchycleaner/go.yml?style=for-the-badge&logo=githubactions&logoColor=white&label=Build&labelColor=111111&color=00c853" alt="Build">
</a>
<a href="https://github.com/knuspii/crunchycleaner/releases">
<img src="https://img.shields.io/github/v/release/knuspii/crunchycleaner?style=for-the-badge&logo=github&logoColor=white&label=Release&labelColor=111111&color=ff6d00" alt="Release">
</a>
<a href="https://github.com/knuspii/crunchycleaner/releases">
<img src="https://img.shields.io/github/downloads/knuspii/crunchycleaner/total?style=for-the-badge&logo=github&logoColor=white&label=Downloads&labelColor=111111&color=8e24aa" alt="Downloads">
</a>
<a href="https://github.com/knuspii/crunchycleaner">
<img src="https://img.shields.io/github/stars/knuspii/crunchycleaner?style=for-the-badge&logo=github&logoColor=white&label=Stars&labelColor=111111&color=fbc02d" alt="Stars">
</a>
</p>

<div align="center">
Expand All @@ -24,17 +29,21 @@
### Supported Software List:
| Category | Software / Path |
| :--- | :--- |
| **System** | System Logs, System Temp Folders, Thumbnail Cache, Shader Cache |
| **Browsers** | Firefox, Google Chrome, Microsoft Edge, Brave, Opera |
| **Development** | Visual Studio Code, Slack, JetBrains IDE, Go, Pip, NPM, Yarn, Cargo, NuGet, Gradle |
| **Gaming** | Steam, Epic Games(Heroic) |
| **Apps** | Discord, Spotify, Thunderbird, Telegram |
| **System:** | System Logs, System Temp, Thumbnail, Shell History, Package Managers, Shader Cache |
| **Browsers:** | Firefox, Google Chrome, Microsoft Edge, Brave, Opera |
| **Development:** | Visual Studio Code, Slack, JetBrains IDE, Go, Pip, NPM, Yarn, Cargo, NuGet, Gradle |
| **Gaming:** | Steam, Epic Games(Heroic) |
| **Apps:** | Discord, Spotify, Thunderbird, Telegram |

**Flatpak is supported** \
**Snap is not supported**
**Snap is NOT supported**

---

## 📥 How to Install & Download ![Download](https://img.shields.io/github/downloads/knuspii/crunchycleaner/total?color=green)
Paste the corresponding command into your terminal and restart it afterwards. \
**Download the latest binary and just run/open it: [[Download here]](https://github.com/knuspii/crunchycleaner/releases)** \
Or paste the corresponding command into your terminal and restart it afterwards to fully install it. \
\
For Linux (using sudo):
```
curl -L https://github.com/Knuspii/CrunchyCleaner/releases/latest/download/crunchycleaner -o cc && sudo install -m 755 cc /usr/local/bin/crunchycleaner && rm cc
Expand All @@ -47,30 +56,24 @@ For Go (using go install):
```
go install github.com/knuspii/crunchycleaner/v2@latest
```
After that you can just type `crunchycleaner -v` into your terminal to verify it's installed. \

Or download the binary and just run/open it:
[[Download here]](https://github.com/knuspii/crunchycleaner/releases)
After that you can just type `crunchycleaner -v` into your terminal to verify it's installed.

---

## Options:
```
-a Automate cleaning (select all and start immediately)
-d Simulation mode without deleting files (for testing)
-t Skip terminal resizing and environment initialization
-v Display version information
```

If you only use a terminal, you might want to use the `-t` flag.

---

> [!WARNING]
> You use this tool at your own risk!

> [!NOTE]
> AI was used for this project in some parts.
> AI was used for this project in some parts. BUT THIS IS NOT VIBECODED!

## Q&A
**Q:** Will this break my system? \
Expand All @@ -84,8 +87,11 @@ If you only use a terminal, you might want to use the `-t` flag.

## Other Downloads
CrunchyCleaner is also available on SourceForge \
\
[![Download CrunchyCleaner](https://a.fsdn.com/con/app/sf-download-button)](https://sourceforge.net/projects/crunchycleaner/files/latest/download)
[![Download CrunchyCleaner](https://img.shields.io/sourceforge/dt/crunchycleaner.svg)](https://sourceforge.net/projects/crunchycleaner/files/latest/download)
[![Total Downloads](https://img.shields.io/sourceforge/dt/crunchycleaner.svg)](https://sourceforge.net/projects/crunchycleaner/files/latest/download)

---

### 🎖️ Featured on
[![Awesome TUIs](https://img.shields.io/badge/Awesome-TUIs-orange?style=flat-square)](https://github.com/rothgar/awesome-tuis)
Expand Down
Binary file modified assets/github.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/github.xcf
Binary file not shown.
Binary file modified assets/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/logo.xcf
Binary file not shown.
Loading
Loading