Skip to content

Commit 42860f7

Browse files
committed
docs: Add CLI to README and download link
1 parent c321e8c commit 42860f7

File tree

1 file changed

+39
-2
lines changed

1 file changed

+39
-2
lines changed

README.md

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,41 @@
1-
# Duplicate Remover
1+
# Duplicate Remover - GUI and CLI tool for removing duplicate files
2+
23

3-
### Find and remove duplicate files efficiently
44
<img src="./docs/screenshot_01.png">
55

6+
```sh
7+
USAGE: duplicate-remover [--help] [<command>] [<options...>] [-- [<application arguments...>]]
8+
9+
Find and remove duplicate files
10+
11+
Duplicate remover scans a directory for identical files based
12+
on their hash. You must either pass export or removal arguments.
13+
Both work on selected files which are a subset of duplicates
14+
chosen through the selection strategy (--select).
15+
Depending on the export type, you may pass additional settings,
16+
like --export-json-quick-include which is supported by the JSON
17+
exporter.
18+
You may delete files permanently (--delete) or move them to the
19+
Trash (--trash) if suported.
20+
21+
22+
Options
23+
=======
24+
25+
-sel --select Selection mode
26+
Supported values: except-largest, except-smallest, largest, smallest, all, none,
27+
-d --dir Directory to scan
28+
--export-file Export desination
29+
--delete Remove selected duplicates permanently
30+
--help Show this help menu
31+
--trash Move select deuplicates to trash
32+
-w --workers Number of workers
33+
--export-type Type of export
34+
Supported values: JSON, JSON Simple, XML, CSV
35+
--export-json-quick-include (JSON export) Explicitly add list of files from each group
36+
Supported values: none, largest, smallest, except-largest, except-smallest
37+
```
38+
639
## Features
740
841
- Extremely fast scanning through use of parallelism and scheduling algorithms
@@ -12,6 +45,10 @@
1245
- Delete files quickly (permanently or moving them to Trash)
1346
- Export scanning results to JSON
1447
48+
## Download
49+
50+
Download duplicate-remover [here](https://github.com/magley/duplicate-remover/releases).
51+
1552
## Benchmarks
1653
1754
### Test 1

0 commit comments

Comments
 (0)