Metadata-Version: 2.4
Name: zencleaner
Version: 1.0.1
Summary: ZenCleaner - type 'zencleaner' in your terminal to open a localhost web UI that actually cleans your PC.
Author: ZenCleaner
License: MIT
Project-URL: Homepage, https://github.com/zencleaner/zencleaner
Keywords: pc-cleaner,windows,privacy,temp-files,localhost,flask,system-cleaner
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: System :: Systems Administration
Classifier: Topic :: Utilities
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: flask>=3.0
Requires-Dist: flask-cors>=4.0
Dynamic: license-file

# ZenCleaner 🧹

> **`pip install zencleaner`** → type **`zencleaner`** in your terminal → a localhost web UI opens → click buttons → it actually cleans your PC.

The website is just the remote control. The real work happens **on your own PC** via a tiny local server bound to `127.0.0.1` — nothing is sent to the internet.

---

## Quick start (Windows)

```bash
pip install zencleaner
```

Open a **new** terminal and type:

```bash
zencleaner
```

Your browser opens automatically at `http://127.0.0.1:8765` with the ZenCleaner web UI.

## Troubleshooting

**`'zencleaner' is not recognized as an internal or external command`**

The install worked, but Windows can't find the command because pip's `Scripts` folder is not on your `PATH` (pip even prints a yellow `WARNING: The script zencleaner.exe is installed in ... which is not on PATH` during install). Any of these fixes work — try them in order:

```bash
py -m zencleaner
```

or run the shim directly:

```bash
python -m zencleaner
```

Or add the `Scripts` folder to PATH: pip's warning shows the exact folder, e.g. `C:\Users\<you>\AppData\Local\Python\pythoncore-3.14-64\Scripts`. Add it via **Settings → search "environment variables" → Edit the system environment variables → Environment Variables → Path → Edit → New**, paste that folder, OK, then open a **new** terminal and `zencleaner` will work.

**`'pip' is not recognized as an internal or external command`**

Python itself isn't installed or wasn't added to PATH. Install Python from [python.org/downloads](https://www.python.org/downloads/) and make sure the **"Add python.exe to PATH"** checkbox is ticked in the installer's first screen, then reopen the terminal and run `py -m pip install zencleaner`.

## What it can clean

| Task | What it does |
|---|---|
| Temp Files | `%TEMP%`, `C:\Windows\Temp` |
| Prefetch | `C:\Windows\Prefetch` (admin only) |
| Recycle Bin | Empty recycle bin |
| Registry MRU | RunMRU, RecentDocs, ComDlg32 (safe keys only) |
| DNS Cache | `ipconfig /flushdns` |
| Clean All | All of the above at once |

## Command-line options

```
zencleaner --help

  --port PORT        Port to run on (default 8765)
  --no-browser       Don't auto-open the browser
  --host HOST        Bind address (default 127.0.0.1 — localhost only)
  --no-elevate       Skip the Windows UAC admin prompt
  --no-auto-kill     Don't kill an old ZenCleaner already on this port
```

## Admin rights

Some tasks (Prefetch, Registry, Forensic) need Windows Admin. On startup ZenCleaner shows a **UAC prompt** — accept it for full power, or cancel/click `--no-elevate` and the UI still works with admin-only tasks disabled.

## Security

- Server binds to `127.0.0.1` only — **nobody on your network or the internet can reach it**.
- No telemetry, no data collection, no outbound calls.
- Every clean action is a real Python function running locally on your machine.

## Stop it

Press `Ctrl+C` in the terminal. The localhost site stops instantly.

## License

MIT — see [LICENSE](LICENSE)
