Skip to content

Commit 5dddf3f

Browse files
Update README.md
1 parent 2ff5c1a commit 5dddf3f

File tree

1 file changed

+22
-9
lines changed

1 file changed

+22
-9
lines changed

README.md

+22-9
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,27 @@ Set executable permissions:
2424
```chmod +x ./snip-snip```
2525

2626
## Options
27+
2728
```shell
28-
-c|--count # Concurrent download queue size controlled by semaphore. A lower value will
29-
# slow down the request rate while avoiding overloading the server. <3
30-
-r|--retry # Retry attempts before giving up on a file.
31-
-f|--failfast # Fail fast if HTTP GET bytes request is not successful.
32-
# Overrides -r|--retry.
33-
-p|--pull # Pull file listing from the files exported text file so only one request is
34-
# needed for the directories of files. Requires a bigger initial to load
35-
# listing.
29+
# Arguments:
30+
URL # Starting with https://
31+
32+
# Options:
33+
-c|--count <COUNT> # Concurrent download queue size controlled by semaphore. A lower value will slow down the
34+
# request rate while avoiding overloading the server. <3
35+
# Default value is: 20.
36+
--fail-fast # Fail fast if HTTP GET file bytes request is not successful. Overrides -r|--retry.
37+
--filter <FILTER> # Filter the list. Non-matching paths are skipped.
38+
-f|--force # Force to overwrite existing files instead of skipping.
39+
--max-depth <MAX_DEPTH> # The maximum depth for files and directories. 0 is recursive.
40+
# Default value is: 0.
41+
-o|--output <OUTPUT> # Output folder for exported files.
42+
# Default value is: Out.
43+
-p|--pull # Pull file listing from files.exported.txt to use instead of JSON listing. Requires an initial
44+
# download to load listing.
45+
-r|--retry <RETRY> # Retry attempts before giving up on a file.
46+
# Default value is: 2.
47+
-?|-h|--help # Show help information.
3648
```
3749

3850
## Tutorial (executable)
@@ -43,7 +55,8 @@ Your binary executable may be different so keep that in mind. (°▽°)
4355
# Run. Limit the download semaphore queue to 16.
4456
./snip-snip.exe -c 16 https://raw.communitydragon.org/latest/game/data/images/
4557
```
46-
Downloaded files and directories will be written in a relative folder called `Out`. If `Out` already exists, it will be overwritten!
58+
Downloaded files and directories will be written in a relative folder called `Out` by default. If a file already exists,
59+
it will be skipped by default.
4760

4861
Wowie it totes worked (hopefully)! Yay!
4962

0 commit comments

Comments
 (0)