An open API service indexing awesome lists of open source software.

https://github.com/funnyhcat-dotcom/repo-cleaner

Safely scan and clean project junk files.
https://github.com/funnyhcat-dotcom/repo-cleaner

cleaner cli developer-tools disk-cleanup nodejs productivity

Last synced: 26 days ago
JSON representation

Safely scan and clean project junk files.

Awesome Lists containing this project

README

          

# repo-cleaner

Safely scan and clean project junk files, caches, build artifacts, logs, and large files.

[![CI](https://github.com/chuzu/repo-cleaner/actions/workflows/ci.yml/badge.svg)](https://github.com/chuzu/repo-cleaner/actions/workflows/ci.yml)

## Why

Projects collect `node_modules`, `.cache`, build output, logs, and random large files. `repo-cleaner` shows what can be cleaned before deleting anything.

## Install

```bash
npm install -g repo-cleaner
```

## Usage

```bash
repo-cleaner
repo-cleaner --dir ./my-project
repo-cleaner --max-size-mb 100
repo-cleaner --json
repo-cleaner --yes
```

## Safety

By default this tool runs in dry-run mode. It only deletes files when you pass `--yes` or confirm interactively. It always skips `.git`.

## Detects

- `.DS_Store`
- `node_modules/`
- `dist/`, `build/`, `.cache/`, `coverage/`, `.next/`
- `__pycache__/`, `.pytest_cache/`
- `*.log`
- files larger than `--max-size-mb`

## Demo

See [docs/DEMO.md](docs/DEMO.md) for a quick hands-on example.

## Development

```bash
npm run check
```

## License

MIT