4 releases (2 breaking)
0.3.0 | Jan 31, 2025 |
---|---|
0.2.1 | Dec 14, 2024 |
0.2.0 | Dec 29, 2023 |
0.1.0 | Jun 24, 2023 |
#231 in Network programming
137 downloads per month
200KB
4.5K
SLoC
GitHub | crates.io | Issues | Changelog
demagnetize
is a Rust program for converting one or more BitTorrent magnet
links into .torrent
files
by downloading the torrent info from active peers.
At the moment, demagnetize
only supports basic features of the BitTorrent
protocol. The following notable features are supported:
- BitTorrent protocol v1
- HTTP (including compact and IPv6 extensions) and UDP trackers
- magnet URIs with info hashes encoded in either hexadecimal or base32
- Fast extension (BEP 6)
- UDP tracker protocol extensions (BEP 41)
The following features are not currently supported but are planned, in no particular order:
- Encryption
- Distributed hash tables
- BitTorrent protocol v2
x.pe
parameters in magnet links- uTP
demagnetize
is a translation of a Python program by the same author; you can
find the Python version at https://github.com/jwodder/demagnetize.
Installation
Release Assets
Prebuilt binaries for the most common platforms are available as GitHub release assets. The page for the latest release lists these under "Assets", along with installer scripts for both Unix-like systems and Windows.
As an alternative to the installer scripts, if you have
cargo-binstall
on your
system, you can use it to download & install the appropriate release asset for
your system for the latest version of demagnetize
by running cargo binstall demagnetize
.
Installing from Source
If you have Rust and Cargo
installed, you can build the latest
release of demagnetize
from source and install it in ~/.cargo/bin
by
running:
cargo install demagnetize
demagnetize
has the following Cargo features, selectable via the --features <LIST>
option to cargo install
:
-
native-tls
— Usenative-tls
for TLS support. This feature is enabled by default. -
native-tls-vendored
— Likenative-tls
, but compile a vendored copy of OpenSSL intodemagnetize
instead of using the platform's copy at runtime. This makes it possible to builddemagnetize
on one system and run it on another system that has a different version of OpenSSL.This feature has no effect on Windows and macOS, where OpenSSL is not used.
-
rustls
— Userustls
for TLS support. When selecting this feature, be sure to also supply the--no-default-features
option in order to disablenative-tls
.- The release assets are built using this feature.
Usage
demagnetize [<global options>] <subcommand> ...
The demagnetize
command has two main general-purpose subcommands, get
(for
converting a single magnet link) and batch
(for converting a file of magnet
links). There are also two low-level commands, query-tracker
(for getting a
list of peers from a single tracker) and query-peer
(for getting torrent
metadata from a single peer).
Global Options
-l <level>
,--log-level <level>
— Set the log level to the given value. Possible values are "OFF
", "ERROR
", "WARN
", "INFO
", "DEBUG
", and "TRACE
" (all case-insensitive). [default value:INFO
]
demagnetize get
demagnetize [<global options>] get [<options>] <magnet-link>
Convert a single magnet link specified on the command line to a .torrent
file. (Note that you will likely have to quote the link in order to prevent it
from being interpreted by the shell.) By default, the file is saved at
{name}.torrent
, where {name}
is replaced by the value of the name
field
from the torrent info, but a different path can be set via the --outfile
option.
Options
-o PATH
,--outfile PATH
— Save the.torrent
file to the given path. The path may contain a{name}
placeholder, which will be replaced by the (sanitized) name of the torrent, and/or a{hash}
placeholder, which will be replaced by the torrent's info hash in hexadecimal. Specifying-
will cause the torrent to be written to standard output. [default:{name}.torrent
]
demagnetize batch
demagnetize [<global options>] batch [<options>] <file>
Read magnet links from <file>
, one per line (ignoring empty lines and lines
that start with #
), and convert each one to a .torrent
file. By default,
each file is saved at {name}.torrent
, where {name}
is replaced by the value
of the name
field from the torrent info, but a different path can be set via
the --outfile
option.
Options
-o PATH
,--outfile PATH
— Save the.torrent
files to the given path. The path may contain a{name}
placeholder, which will be replaced by the (sanitized) name of each torrent, and/or a{hash}
placeholder, which will be replaced by each torrent's info hash in hexadecimal. [default:{name}.torrent
]
demagnetize query-tracker
demagnetize [<global options>] query-tracker <tracker> <info-hash>
Query the given tracker (specified as an HTTP or UDP URL) for peers serving the torrent with the given info hash (specified as a 40-character hex string or 32-character base32 string), and print out the the retrieved peers' addresses in the form "IP:PORT".
demagnetize query-peer
demagnetize [<global options>] query-peer [<options>] <peer> <info-hash>
Query the given peer (specified as an address in "IPv4:PORT" or "[IPv6]:PORT"
format) for the metadata of the torrent with the given info hash (specified as
a 40-character hex string or 32-character base32 string), and save the metadata
to a file. By default, the file is saved at {name}.torrent
, where {name}
is replaced by the value of the name
field from the torrent info, but a
different path can be set via the --outfile
option.
Note that, unlike the .torrent
files produced by the get
and batch
commands, the files produced by this command will not contain tracker
information.
Options
-o PATH
,--outfile PATH
— Save the.torrent
file to the given path. The path may contain a{name}
placeholder, which will be replaced by the (sanitized) name of the torrent, and/or a{hash}
placeholder, which will be replaced by the torrent's info hash in hexadecimal. Specifying-
will cause the torrent to be written to standard output. [default:{name}.torrent
]
Dependencies
~13–28MB
~457K SLoC