Skip to content

Commit 2e5a170

Browse files
committed
Rework usage/install
1 parent 2694f8c commit 2e5a170

File tree

1 file changed

+31
-29
lines changed

1 file changed

+31
-29
lines changed

README.md

Lines changed: 31 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,17 @@
2525
---
2626

2727
<!--ts-->
28-
* [Demo](#Demo)
29-
* [Installation](#Installation)
30-
* [Dependencies](#dependencies)
31-
* [Run with pipx](#run-with-pipx)
32-
* [Installation from pip](#installation-from-pip)
33-
* [Installation from AUR](#installation-from-aur)
34-
* [Usage](#Usage)
35-
* [Tips](#Tips)
36-
* [Contributing](#Contributing)
28+
29+
* [Demo](#Demo)
30+
* [Installation](#Installation)
31+
* [Dependencies](#dependencies)
32+
* [Run with pipx](#run-with-pipx)
33+
* [Installation from pip](#installation-from-pip)
34+
* [Installation from AUR](#installation-from-aur)
35+
* [Usage](#Usage)
36+
* [Tips](#Tips)
37+
* [Contributing](#Contributing)
38+
3739
<!--te-->
3840

3941
---
@@ -45,54 +47,51 @@ RecoverPy is a powerful tool that leverages your system capabilities to recover
4547
Unlike others, you can not only recover deleted files but also **overwritten** data.
4648

4749
Every block of your partition will be scanned. You can even find a string in binary files.
50+
4851
## Demo
4952

5053
<p align="center">
5154
<img src="docs/assets/demo.gif">
5255
</p>
5356

54-
## Installation
57+
## Setup
5558

5659
:penguin: RecoverPy is currently only available on Linux systems.
5760
:red_circle: **You must be root or use sudo**.
5861

5962
### Dependencies
6063

61-
**Mandatory:** To list and search through your partitions, recoverpy uses `grep`, `dd`, and `lsblk` commands. Although, if you're running a major Linux distrucition these tools should already be installed.
64+
**Mandatory:** To list and search through your partitions, recoverpy uses `grep`, `dd`, and `lsblk` commands. Although,
65+
if you're running a major Linux distrucition these tools should already be installed.
6266

6367
**Optional:** To display real time grep progress, you can install `progress`.
6468

6569
To install all dependencies:
70+
6671
- Debian-like: `apt install grep coreutils util-linux progress`
6772
- Arch: `pacman -S grep coreutils util-linux progress`
6873
- Fedora: `dnf install grep coreutils util-linux progress`
6974

75+
## Usage
7076

71-
### Run with pipx
77+
### Run with uvx
7278

73-
You can **directly run recoverpy with pipx in an isolated environment** without installing it.
74-
To install pipx, follow the [official documentation](https://pipxproject.github.io/pipx/installation/).
75-
To run recoverpy with pipx, simply run:
79+
`sudo uvx recoverpy`
80+
81+
### Run with pipx
7682

7783
`sudo pipx run recoverpy`
7884

79-
#### Installation from pip
85+
### Installation from pip
8086

8187
`python3 -m pip install recoverpy`
8288

83-
#### Installation from AUR
84-
85-
`yay -S python-recoverpy`
86-
87-
## Usage
88-
89-
```bash
90-
python3 -m recoverpy
91-
```
89+
then run `sudo python3 -m recoverpy`
9290

9391
---
9492

95-
- **Select the system partition** in which your file was. If you are out of luck, you can alternatively search in your home partition, maybe your IDE, text editor, etc. made a backup at some point.
93+
- **Select the system partition** in which your file was. If you are out of luck, you can alternatively search in your
94+
home partition, maybe your IDE, text editor, etc. made a backup at some point.
9695

9796
- **Type a text string to search**. See tips below for better results.
9897

@@ -102,12 +101,14 @@ python3 -m recoverpy
102101

103102
- Once you have found your precious, **select `Open`**.
104103

105-
- You can now either save this block individually or explore neighboring blocks for the remaining parts of the file. You could then save it all in one file.
104+
- You can now either save this block individually or explore neighboring blocks for the remaining parts of the file. You
105+
could then save it all in one file.
106106

107107
## Tips
108108

109109
- Always do backups! Yes, maybe too late...
110-
- **Unmount your partition before you do anything!** Although you can search with your partition still mounted, it is highly recommended to unmount your partition to avoid any alteration to your file.
110+
- **Unmount your partition before you do anything!** Although you can search with your partition still mounted, it is
111+
highly recommended to unmount your partition to avoid any alteration to your file.
111112

112113
Regarding the searched string:
113114

@@ -117,7 +118,8 @@ Regarding the searched string:
117118

118119
When you have found your file:
119120

120-
- You might see multiple results. Your system often use different partion blocks to save successive versions of a file. Make sure you've found the last version.
121+
- You might see multiple results. Your system often use different partion blocks to save successive versions of a file.
122+
Make sure you've found the last version.
121123
- Try exploring neighboring blocks to be sure to save your whole file.
122124

123125
## Contributing

0 commit comments

Comments
 (0)