https://github.com/pablolec/recoverpy
Interactively find and recover deleted or :point_right: overwritten :point_left: files from your terminal
https://github.com/pablolec/recoverpy
cli console cybersecurity data data-recovery files forensics hacking linux macos pentesting python python3 recovery search search-interface terminal textual tool tui
Last synced: about 19 hours ago
JSON representation
Interactively find and recover deleted or :point_right: overwritten :point_left: files from your terminal
- Host: GitHub
- URL: https://github.com/pablolec/recoverpy
- Owner: PabloLec
- License: gpl-3.0
- Created: 2021-02-24T14:42:33.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-05-02T13:22:00.000Z (5 months ago)
- Last Synced: 2025-05-02T14:42:03.326Z (5 months ago)
- Topics: cli, console, cybersecurity, data, data-recovery, files, forensics, hacking, linux, macos, pentesting, python, python3, recovery, search, search-interface, terminal, textual, tool, tui
- Language: Python
- Homepage:
- Size: 15 MB
- Stars: 1,478
- Watchers: 14
- Forks: 76
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
RecoverPy
Find and recover deleted or even overwritten files from your Linux partitions, quickly and easily.
---
RecoverPy doesn't just recover deleted files, but also helps you **recover overwritten data** by scanning each disk block. Whether it's a lost snippet of code, accidentally deleted configs, or overwritten text files, RecoverPy gives you a powerful, interactive way to get it back.
## ✨ Features
- ✅ Recover **overwritten and deleted files**
- 🔍 Search file contents by string, even in binary files
- 📟 Modern, easy-to-use terminal UI
- 🐧 Linux compatible (all file systems supported)
- ⚡️ Fast, leveraging core Linux utilities (`grep`, `dd`, `lsblk`)
---
## 🎬 Demo
---
## 📦 Installation
> **Warning:** You **must** run RecoverPy as root (`sudo`).
RecoverPy is Linux-only. Make sure you have these common tools installed (`grep`, `dd`, `lsblk`). Optionally, install `progress` to monitor scan progress:
```bash
# Debian / Ubuntu
sudo apt install grep coreutils util-linux progress
# Arch
sudo pacman -S grep coreutils util-linux progress
# Fedora
sudo dnf install grep coreutils util-linux progress
```
### Quick Run (no installation)
Using `pipx`:
```bash
sudo pipx run recoverpy
```
Or using `uvx`:
```bash
sudo uvx recoverpy
```
### Install from PyPI
```bash
python3 -m pip install recoverpy
sudo recoverpy
```
---
## 💻 Usage
1. **Launch RecoverPy:**
```bash
sudo recoverpy
```
2. **Select Partition:**
Choose the partition where your lost data resides. If unsure, try scanning your `/home` partition, it might contain editor or IDE backups.
3. **Search Content:**
Enter a unique string from the lost file content. RecoverPy will scan disk blocks to locate matches.
4. **Find & Recover:**
Results appear interactively. Select a result, preview the block, and save it. Explore neighboring blocks if the file spans multiple disk blocks.
---
## 💡 Recovery Tips
- 🛑 **Unmount partition first:** Reduce risk of data overwriting.
- 🎯 **Be specific:** Use unique, simple search strings.
- ⏳ **Act quickly:** The sooner you scan, the higher your recovery chances.
- 📑 **Check adjacent blocks:** Your file might span several blocks, check them all.
---
## 🤝 Contributing
Found a bug or have an idea? PRs, issues, and suggestions are warmly welcome. Check out our [contributing guide](CONTRIBUTING.md) for how to get involved!
---
If RecoverPy saved your day, consider ⭐️ starring the repo, thanks for your support!