https://github.com/jwodder/demagnetize-rs
Convert magnet links to .torrent files
https://github.com/jwodder/demagnetize-rs
available-on-crates-io bittorent magnet-link rust torrent
Last synced: about 2 months ago
JSON representation
Convert magnet links to .torrent files
- Host: GitHub
- URL: https://github.com/jwodder/demagnetize-rs
- Owner: jwodder
- License: mit
- Created: 2023-06-17T20:17:09.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-08T12:31:51.000Z (about 1 year ago)
- Last Synced: 2024-04-08T13:41:40.780Z (about 1 year ago)
- Topics: available-on-crates-io, bittorent, magnet-link, rust, torrent
- Language: Rust
- Homepage:
- Size: 324 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.repostatus.org/#active)
[](https://github.com/jwodder/demagnetize-rs/actions/workflows/test.yml)
[](https://codecov.io/gh/jwodder/demagnetize-rs)
[](https://www.rust-lang.org)
[](https://opensource.org/licenses/MIT)
[GitHub](https://github.com/jwodder/demagnetize-rs) | [crates.io](https://crates.io/crates/demagnetize) | [Issues](https://github.com/jwodder/demagnetize-rs/issues) | [Changelog](https://github.com/jwodder/demagnetize-rs/blob/master/CHANGELOG.md)
`demagnetize` is a Rust program for converting one or more BitTorrent [magnet
links](https://en.wikipedia.org/wiki/Magnet_URI_scheme) 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](https://www.bittorrent.org/beps/bep_0006.html))
- UDP tracker protocol extensions ([BEP
41](https://www.bittorrent.org/beps/bep_0041.html))
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 .
Installation
============
Release Assets
--------------
Prebuilt binaries for the most common platforms are available as GitHub release
assets. [The page for the latest
release](https://github.com/jwodder/demagnetize-rs/releases/latest) 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`](https://github.com/cargo-bins/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](https://www.rust-lang.org/tools/install), 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
` option to `cargo install`:
- `native-tls` — Use [`native-tls`](https://github.com/sfackler/rust-native-tls)
for TLS support. This feature is enabled by default.
- `native-tls-vendored` — Like `native-tls`, but compile a vendored copy of
OpenSSL into `demagnetize` instead of using the platform's copy at runtime.
This makes it possible to build `demagnetize` 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` — Use [`rustls`](https://github.com/rustls/rustls) for TLS support.
When selecting this feature, be sure to also supply the
`--no-default-features` option in order to disable `native-tls`.
- The release assets are built using this feature.
Usage
=====
demagnetize [] ...
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 `, `--log-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 [] get []
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 [] batch []
Read magnet links from ``, 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 [] query-tracker
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 [] query-peer []
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`]