Skip to main content

Usage

Create torrents in two modes:
  • Single file/directory mode (default)
  • Batch mode using a YAML config file
Common settings can be saved and reused with presets.By default, when a tracker URL is provided, the output filename will be prefixed with the tracker domain (e.g. “example_filename.torrent”). Use --skip-prefix to disable this behavior.

Arguments

  • /path/to/content: (Required unless using -b) The path to the source file or directory.

Flags

Input & Output

string[]
Tracker URL. Can be specified multiple times to add several trackers. Optional.
string
Set torrent name (default: source filename).
string
Optional. Set output path (default: <n>.torrent or <tracker-prefix>_<n>.torrent).
string
Output directory for created torrent.
boolean
default:false
Don’t add tracker domain prefix to output filename.

Advanced Input (Batch & Presets)

string
Batch config file (YAML). Cannot be used with a path argument.
For creating multiple torrents in one go. See the Batch Mode documentation for details.
string
Use preset from config.
For reusing common settings across torrents. See the Presets documentation for details.
string
Preset config file (default ~/.config/mkbrr/presets.yaml).
Set custom path to presets.yaml. See the Presets documentation for details.

Content Selection

array
Exclude files matching these patterns (e.g., "*.nfo,*.jpg" or --exclude "*.nfo" --exclude "*.jpg").
Use this to filter out unwanted files like NFOs, samples, or extras that shouldn’t be in the torrent. See the filtering guide for detailed pattern rules and examples.
array
Include only files matching these patterns (e.g., "*.mkv,*.mp4" or --include "*.mkv" --include "*.mp4").
Using include patterns activates whitelist mode. See the filtering guide for detailed pattern rules and examples.

Torrent Internals

boolean
default:true
Make torrent private.
Private flag is enabled by default for tracker compliance. Only disable if you’re creating a public torrent.
number
Set piece length to 2^n bytes (16-27, automatic if not specified).
Let mkbrr automatically calculate the piece size unless you have specific requirements. The automatic calculation optimizes for both performance and compatibility.
number
Limit maximum automatically calculated piece length to 2^n bytes (14-27).
number
Target approximate number of pieces. Calculates optimal piece length automatically. Mutually exclusive with --piece-length.
boolean
default:false
Randomize the torrent’s info hash by adding or updating a unique, random entropy key in the info dictionary before hashing.
Cross-seeding is the practice of seeding the same content on multiple trackers. Using the entropy flag helps avoid conflicts between trackers.

Seeding & Metadata

array
Specify web seed URLs. Can be used multiple times.
Web seeds provide an HTTP fallback source for the torrent content, improving availability.
string
Specify the source string.
Some trackers require or recommend specific source tags. Check your tracker’s rules.
string
Specify a comment.
boolean
default:false
Omit the creation date from the torrent metadata.
boolean
default:false
Omit the creator string from the torrent metadata.

Season Pack Detection

boolean
default:false
Exit with error if season pack completeness check detects missing episodes.

Execution & Output Control

number
Manually specify the number of concurrent goroutines used for hashing.
Experimenting with different worker values might yield better performance than the default automatic setting.
boolean
default:false
Be verbose.
boolean
default:false
Enable quiet mode, printing only the final torrent file path upon success. Useful for scripts.
boolean
default:false
Display only torrent info without progress (implies verbose).