Welcome to dottorrent-cli’s documentation!

dottorrent-cli is a command-line interface (CLI) tool for creating .torrent files, powered by dottorrent.

Features

  • Fast (capable of several hundred MB/s)
  • Full Unicode support
  • Automatic and manual piece size selection
  • HTTP/web seeds support (BEP 19)
  • Private flag support (BEP 27)
  • Source string support
  • Comment field support
  • Filename pattern exclusion
  • Per-file MD5 hash computation

Contents:

Installation

Requirements

  • Python 3.3+ (Python 3.5+ recommended)
  • dottorrent 1.9.2+
  • See requirements.txt for additional dependencies.

Stable releases are available on PyPI and can be installed using pip.

pip install dottorrent-cli

To install from the latest development sources, clone the git repo and run pip install .

Command-line tool

If you installed dottorrent-cli using pip, dottorrent should be available in your system path.

usage: dottorrent [-h] [--tracker TRACKER] [--web_seed WEB_SEED]
          [--piece_size PIECE_SIZE] [--private] [--source SOURCE]
          [--exclude RE] [--comment COMMENT] [--date DATE] [--md5]
          [--verbose]
          path output_path

Create a .torrent file

positional arguments:
path                  path to file/directory to create torrent from
output_path           Output path for created .torrent file. If a directory
                                                is provided, the filename will be automatically
                                                generated based on the input.

optional arguments:
-h, --help            show this help message and exit
--tracker TRACKER, -t TRACKER
                                                tracker URL (can be specified multiple times)
--web_seed WEB_SEED, -w WEB_SEED
                                                web seed URL (can be specified multiple times)
--piece_size PIECE_SIZE, -s PIECE_SIZE
                                                piece size, e.g. 16KB, 1M. Leave unspecified for
                                                automatic piece size
--private, -p         set private flag (useful for private trackers)
--source SOURCE       source string (useful for private trackers)
--exclude RE, -x RE   filename patterns that should be excluded (can be
                                                specified multiple times)
--comment COMMENT, -c COMMENT
                                                string for the torrent comment field
--date DATE, -d DATE  Torrent creation date. Valid values: unix
                                                timestamp/none/now (default: now)
--md5                 Add per-file MD5 hashes
--verbose, -v         verbose mode

dottorrent/1.10.0 (https://github.com/kz26/dottorrent-cli)

When creating a torrent, all dotfiles (filenames beginning with a ‘.’) are excluded. On Windows systems running Python 3.5+, all hidden files are excluded as well.

To add multiple trackers, web seeds and/or exclusion patterns, repeat the -t, -w, or -x as many times as necessary, e.g. -t tracker1 -t tracker2 or -x "*.jpg" --exclude "*.png".

dottorrent-gui

An official GUI for dottorrent is available. Please see https://github.com/kz26/dottorrent-gui for more information.

Changelog

1.10.3

  • Determine writability of output path prior to torrent generation (issue #6)

1.10.2

  • fix handling when input is a directory containing a period (PR #2)

1.10.1

  • Fix missing files in PyPI packages

1.10.0

  • First release split off from dottorrent

Indices and tables