Hojun-Cho
3eb2d5ffcb
Surface area, not the machinery, was the problem: 16 flags crowded the bare --help. Re-tag so basic shows only the 10 outcome-changing flags; every other flag still works behind --help=<group>. - cut --bt-metadata-timeout, an invented flag with no real counterpart. Keep its 60s magnet-metadata stall as a fixed internal default (bt.go), not a user knob. - fix the parallelism footgun: a bare `got URL` used min(split,x)=1 connection. When -x is unset, let --split drive per-host connections (capped at 16), so `got URL` gets 5 and `-s16` gets 16. An explicit -x is honored verbatim, including -x1. Locked by TestHTTPConnDefault. - -s is the per-download speed dial now, so it moves to basic; -x (a per-server cap) moves to the http group. -j help says "files at once, not connections within one file".
75 lines
2.4 KiB
Markdown
75 lines
2.4 KiB
Markdown
# got
|
||
|
||
A command-line download tool in Go. It fetches HTTP(S) files over multiple
|
||
connections and downloads BitTorrent magnets and `.torrent` files — one binary,
|
||
familiar flags.
|
||
|
||
## Build
|
||
|
||
```sh
|
||
go build -o got .
|
||
```
|
||
|
||
Needs Go 1.25+.
|
||
|
||
## Usage
|
||
|
||
```sh
|
||
# HTTP download: parallel out of the box (5 connections); -s turns it up
|
||
got https://example.com/big.iso
|
||
got -s16 https://example.com/big.iso
|
||
|
||
# resume an interrupted download
|
||
got -c https://example.com/big.iso
|
||
|
||
# one file from several mirrors (connections spread across servers,
|
||
# a dead mirror falls over); -Z downloads them as separate files instead.
|
||
# -x caps connections per server when mirroring.
|
||
got -s16 -x4 https://a.example/big.iso https://b.example/big.iso
|
||
|
||
# a torrent or magnet; seed for 30 minutes after finishing
|
||
got --seed-time=30 ubuntu.torrent
|
||
got 'magnet:?xt=urn:btih:...'
|
||
|
||
# many downloads, two at a time
|
||
got -j2 -i urls.txt
|
||
```
|
||
|
||
Run `got --help` (or `--help=all`) for every option.
|
||
|
||
## Common options
|
||
|
||
| flag | meaning | default |
|
||
|------|---------|---------|
|
||
| `-d, --dir` | output directory | `.` |
|
||
| `-o, --out` | output filename | from URL |
|
||
| `-c, --continue` | resume a partial download | false |
|
||
| `-s, --split` | connections per download (the speed dial) | 5 |
|
||
| `-x, --max-connection-per-server` | cap connections per server (1–16) | 1 (= split when unset) |
|
||
| `-j, --max-concurrent-downloads` | files downloaded at once | 5 |
|
||
| `--max-overall-download-limit` | global speed cap | 0 (off) |
|
||
| `--checksum` | verify the finished file: `TYPE=DIGEST` (sha-256, sha-1, …) | |
|
||
| `--seed-time` | minutes to seed after a torrent finishes | by ratio |
|
||
| `--seed-ratio` | stop seeding at this ratio | 1.0 |
|
||
| `-S, --show-files` | list torrent files and exit | |
|
||
| `-q, --quiet` | no progress output | false |
|
||
|
||
## Resume
|
||
|
||
HTTP downloads resume from a small `<file>.got` sidecar — just re-run with `-c`.
|
||
Torrents resume from the data already on disk. To resume across runs, point
|
||
`--save-session` and `-i` at the same file:
|
||
|
||
```sh
|
||
got -c --save-session=got.session -i got.session <urls/magnets...>
|
||
```
|
||
|
||
## Notes
|
||
|
||
- BitTorrent uses [`anacrolix/torrent`](https://github.com/anacrolix/torrent);
|
||
HTTP uses the standard library.
|
||
- Not implemented: FTP/SFTP, Metalink, and the JSON-RPC server.
|
||
- When several torrents run at once, `--max-download-limit` /
|
||
`--max-upload-limit` apply per run rather than per torrent (`--max-overall-*`
|
||
are exact).
|